MyShaarli/doc/md/Coding-guidelines.md at 64d748bbe46ef76631a88a4345159e9c6a4e341a - Knah-Tsaeb/MyShaarli - Forgejo: Beyond coding. We forge.

Knah-Tsaeb/MyShaarli

nodiscc 53ed6d7d1e Generate HTML documentation using MkDocs (WIP)

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

2017-06-18 00:19:49 +02:00

5 lines

243 B

Markdown

Raw Blame History

 ## WIP
 This topic is currently being discussed here:
 - [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95)
 - [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130)