You may have noticed that the
markdown files in the
/docs directory are also displayed on Kilo's website.
If you want to add documentation to Kilo, you can start a local webserver to check out how the website would look like.
The markdown files for the website are located in
/website/docs and are generated from the like-named markdown files in the
/docs directory and from the corresponding header files without the
.md extension in the
To generate the markdown files in
Next, build the website itself by installing the
node_modules and building the website's HTML from the generated markdown:
Now, start the website server with:
yarn --cwd website start
This command should have opened a browser window with the website; if not, open your browser and point it to
If you make changes to any of the markdown files in
/docs and want to reload the local
node server, run:
make website/docs/README.md -B
You can execute the above while the node server is running and the website will be rebuilt and reloaded automatically.
If you add a new file to the
/docs directory, you also need to create a corresponding header file containing the front-matter in
Then, regenerate the markdown for the website with the command:
idin the header file
/website/docs/<new file>must match the