webdsl/webdsl-docs

WebDSL language documentation

WebDSL Documentation

This is the repository for the new WebDSL documentation. This documentation uses MkDocs Material.

The result is currently available at https://webdsl.github.io/webdsl-docs/.

To build the pages and see edits live using Docker:

make

Or using Python 3:

pip install -r mkdocs_requirements.txt
mkdocs serve

Navigate to localhost:8000 to see the documentation. The local documentation is automatically reloaded when changes occur. Changes pushed to the main branch are automatically deployed to Github Pages.

Adding Pages

New pages should be added to the mkdocs.yml nav element. The first page mentioned under a section header should be some **/index.md without a label, and will be used as the index page for that section.