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 /.gitattributes | |
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 '.gitattributes')
-rw-r--r-- | .gitattributes | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes index 82f37602..dd0e573c 100644 --- a/.gitattributes +++ b/.gitattributes | |||
@@ -33,5 +33,6 @@ doc/**/*.md export-ignore | |||
33 | docker/ export-ignore | 33 | docker/ export-ignore |
34 | Doxyfile export-ignore | 34 | Doxyfile export-ignore |
35 | Makefile export-ignore | 35 | Makefile export-ignore |
36 | mkdocs.yml export-ignore | ||
36 | phpunit.xml export-ignore | 37 | phpunit.xml export-ignore |
37 | tests/ export-ignore | 38 | tests/ export-ignore |