V Documentation Generator

A simple generator to create multi-page documentation from the original V docs.md

External dependencies

This project only requires V. Best to install it from source if you don't already have it.

To setup the generator and contribute changes to it, do this once:

git clone --branch generator https://github.com/vlang/docs docs_generator/
cd docs_generator/
v install

This will install all dependencies, and setup everything needed for you to generate the documentation on your computer.

To build the documentation, after the setup, run the following commands:

v run .

This will download the latest version of docs.md, then it will regenerate the documentation from it, and save it in the output directory.

Use V to serve your local copy of the documentation.

v -e 'import net.http.file; file.serve(folder: "output/")'

The line of code executed will start a basic web server with the documentation created in the "outputs" folder.

Access the documentation on your browser using this url http://localhost:4001/.