aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/index.md
Commit message (Collapse)AuthorAgeFilesLines
* Typo's, unified structure a bit.B. van Berkum2017-10-031-2/+1
| | | | | | - Fixes inevitable typo that crept in. - Removed some blank lines, newlines, to match established whitespace use better. - Minor grammar improvement.
* Added docker quickstart example, with user-data volumeB. van Berkum2017-10-031-0/+12
|
* migrated Github wiki links to readthedocsWilli Eggeling2017-08-261-1/+1
|
* documentation: fix rendering and internal referencesVirtualTam2017-08-051-1/+2
| | | | | | | | | | | | | | | | | | | This is mainly cleanup after switching from Github-flavoured Markdown rendered by Github Pages, to standard Markdown rendered by MkDocs. Changed: - rephrase some section titles Fixed: - list rendering (items, sub-items)) - code rendering - quotes - dead links Removed: - extraneous navigational elements Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* move README contents to doc/md/index.mdnodiscc2017-06-181-3/+106
|
* Generate HTML documentation using MkDocs (WIP)nodiscc2017-06-181-0/+11
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation