README.md

Lesgo! Documentation

You can find the online version of the Lesgo! documentation at https://reflex-media.github.io/lesgo-docs

Contribution Guidelines

This documentation is powered by MkDocs. For full documentation visit mkdocs.org.

To encourage active collaboration, we encourage and accept Pull Requests.

Installation

Refer to the official MkDocs for installation instructions.

Commands

Install python packages

$ pip install -r requirements.txt

Quick Start

Start mkdocs on your local machine with live reloading.

$ mkdocs serve

The local site will be available at http://127.0.0.1:8000.

Build

Build the static html site, ready for deployment.

$ mkdocs build

The static files will be stored in the site/ directory.

Deploy

This command will deploy the static site in site/ directory to GitHub Pages.

$ mike deploy 0.6.3 stable

or

$ mike deploy 0.7.0

Preview Deploy

This command will preview the currently updated site under gh-pages branch

$ mike serve

Architecture

├── docs          # Markdown files
├── site          # Static site
└── mkdocs.yml    # MkDocs configurations