/flask-docs

flask-docs

Primary LanguageHTMLMIT LicenseMIT

flask-docs

flask-docs

Tools

The documentaions use a markdown editor (MkDocs) to create and generate documentation and save in GitHub Pages. See https://www.mkdocs.org/

MkDocs is a fast, simple and good looking static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

MkDocs builds completely static HTML sites that is hosted on GitHub pages on the flask-docs project repo The master branch contains the published static HTML and development branch(es) will contain the MkDocs project source markdown files.

Installation

Run apt-get install mkdocs

Running

Run mkdocs serve Open your browser - http://127.0.0.1:8000

Run mkdocs build

Run mkdocs gh-deploy