JacobDev1 / xl-converter-docs

Documentation for XL Converter written in ReactJS / TypeScript.

XL Converter Documentation

The documentation for XL Converter.

Hosted here.

Features:

• Search engine
• Clean design
• Mobile-friendly

Running

Install nvm

Use latest NodeJS LTS

nvm install --lts

npm i
make run

Generating Search Index

The search index should be re-generated before deployment.

First, run the project

npm i
make run

Open another terminal

sudo apt install python3 python3-pip python3-venv firefox
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt

Finally, generate the search index.

make index

Testing

make test

Deploying

make build

Apache

Create a file named .htaccess with the following inside.

Options -MultiViews
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.html [QSA,L]

Then put it next to index.html.