XL Converter Documentation

The documentation for XL Converter.

Hosted here.

Features a search engine based on a local index.

Running

Install nvm

Use latest NodeJS LTS

nvm install --lts

Clone the repo.

git clone https://github.com/JacobDev1/xl-converter-docs.git

Tip

If you need a specific version, use git checkout <version_tag>

Install packages and and run.

npm i
npm run dev

Generating Search Index

The search index should be re-generated before deployment.

First, run the project.

npm i
npm run dev

Open another terminal and install Python.

sudo apt install python3 python3-pip python3-venv firefox

Create a venv.

make venv
source env/bin/activate

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.