diff options
| author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
|---|---|---|
| committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
| commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
| tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/config.json | |
| parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
| download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip | |
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
Diffstat (limited to 'doc/md/config.json')
| -rw-r--r-- | doc/md/config.json | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/md/config.json b/doc/md/config.json new file mode 100644 index 00000000..cc4de307 --- /dev/null +++ b/doc/md/config.json | |||
| @@ -0,0 +1,6 @@ | |||
| 1 | { | ||
| 2 | "useSideMenu": true, | ||
| 3 | "lineBreaks": "gfm", | ||
| 4 | "additionalFooterText": "", | ||
| 5 | "title": "Shaarli documentation" | ||
| 6 | } \ No newline at end of file | ||