]> git.immae.eu Git - github/shaarli/Shaarli.git/commit - mkdocs.yml
Generate HTML documentation using MkDocs (WIP)
authornodiscc <nodiscc@gmail.com>
Thu, 26 Jan 2017 17:52:54 +0000 (18:52 +0100)
committernodiscc <nodiscc@gmail.com>
Sat, 17 Jun 2017 22:19:49 +0000 (00:19 +0200)
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac
treef8bef0164a70bd03d2b9781951c01bdd018f1842
parentd5d22a6d07917865c44148ad76f43c65a929a890
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
162 files changed:
.gitattributes
Makefile
doc/3rd-party-libraries.html [deleted file]
doc/Backup,-restore,-import-and-export.html [deleted file]
doc/Browsing-and-searching.html [deleted file]
doc/Coding-guidelines.html [deleted file]
doc/Community-&-Related-software.html [deleted file]
doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html [deleted file]
doc/Create-and-serve-multiple-Shaarlis-(farm).html [deleted file]
doc/Datastore-hacks.html [deleted file]
doc/Development.html [deleted file]
doc/Development.md [deleted file]
doc/Directory-structure.html [deleted file]
doc/Docker.html [deleted file]
doc/Download-CSS-styles-from-an-OPML-list.html [deleted file]
doc/Download-and-Installation.html [deleted file]
doc/Example-patch---add-new-via-field-for-links.html [deleted file]
doc/FAQ.html [deleted file]
doc/Firefox-share.html [deleted file]
doc/GnuPG-signature.html [deleted file]
doc/Home.html [deleted file]
doc/Plugin-System.html [deleted file]
doc/Plugins.html [deleted file]
doc/REST-API.html [deleted file]
doc/RSS-feeds.html [deleted file]
doc/Release-Shaarli.html [deleted file]
doc/Security.html [deleted file]
doc/Server-configuration.html [deleted file]
doc/Server-requirements.html [deleted file]
doc/Server-security.html [deleted file]
doc/Shaarli-configuration.html [deleted file]
doc/Sharing-button.html [deleted file]
doc/Static-analysis.html [deleted file]
doc/Theming.html [deleted file]
doc/Troubleshooting.html [deleted file]
doc/Unit-tests.html [deleted file]
doc/Upgrade-and-migration.html [deleted file]
doc/Usage.html [deleted file]
doc/Versioning-and-Branches.html [deleted file]
doc/_Footer.html [deleted file]
doc/_Sidebar.html [deleted file]
doc/html/3rd-party-libraries/index.html [new file with mode: 0644]
doc/html/Backup,-restore,-import-and-export/index.html [new file with mode: 0644]
doc/html/Bookmarklet/index.html [new file with mode: 0644]
doc/html/Browsing-and-searching/index.html [new file with mode: 0644]
doc/html/Coding-guidelines/index.html [new file with mode: 0644]
doc/html/Community-&-Related-software/index.html [new file with mode: 0644]
doc/html/Continuous-integration-tools/index.html [new file with mode: 0644]
doc/html/Copy-an-existing-installation-over-SSH-and-serve-it-locally/index.html [new file with mode: 0644]
doc/html/Create-and-serve-multiple-Shaarlis-(farm)/index.html [new file with mode: 0644]
doc/html/Datastore-hacks/index.html [new file with mode: 0644]
doc/html/Development-guidelines/index.html [new file with mode: 0644]
doc/html/Directory-structure/index.html [new file with mode: 0644]
doc/html/Docker-101/index.html [new file with mode: 0644]
doc/html/Docker-resources/index.html [new file with mode: 0644]
doc/html/Download-CSS-styles-from-an-OPML-list/index.html [new file with mode: 0644]
doc/html/Download-and-Installation/index.html [new file with mode: 0644]
doc/html/FAQ/index.html [new file with mode: 0644]
doc/html/Features/index.html [new file with mode: 0644]
doc/html/Firefox-share/index.html [new file with mode: 0644]
doc/html/GnuPG-signature/index.html [new file with mode: 0644]
doc/html/Plugin-System/index.html [new file with mode: 0644]
doc/html/Plugins/index.html [new file with mode: 0644]
doc/html/REST-API/index.html [new file with mode: 0644]
doc/html/RSS-feeds/index.html [new file with mode: 0644]
doc/html/Release-Shaarli/index.html [new file with mode: 0644]
doc/html/Reverse-proxy-configuration/index.html [new file with mode: 0644]
doc/html/Security/index.html [new file with mode: 0644]
doc/html/Server-configuration/index.html [new file with mode: 0644]
doc/html/Server-requirements/index.html [new file with mode: 0644]
doc/html/Server-security/index.html [new file with mode: 0644]
doc/html/Shaarli-configuration/index.html [new file with mode: 0644]
doc/html/Shaarli-images/index.html [new file with mode: 0644]
doc/html/Static-analysis/index.html [new file with mode: 0644]
doc/html/Theming/index.html [new file with mode: 0644]
doc/html/Troubleshooting/index.html [new file with mode: 0644]
doc/html/Unit-tests/index.html [new file with mode: 0644]
doc/html/Upgrade-and-migration/index.html [new file with mode: 0644]
doc/html/Versioning-and-Branches/index.html [new file with mode: 0644]
doc/html/config.json [moved from doc/config.json with 100% similarity]
doc/html/css/highlight.css [new file with mode: 0644]
doc/html/css/theme.css [new file with mode: 0644]
doc/html/css/theme_extra.css [new file with mode: 0644]
doc/html/fonts/fontawesome-webfont.eot [new file with mode: 0644]
doc/html/fonts/fontawesome-webfont.svg [new file with mode: 0644]
doc/html/fonts/fontawesome-webfont.ttf [new file with mode: 0644]
doc/html/fonts/fontawesome-webfont.woff [new file with mode: 0644]
doc/html/github-markdown.css [moved from doc/github-markdown.css with 100% similarity]
doc/html/images/bookmarklet.png [moved from doc/images/bookmarklet.png with 100% similarity]
doc/html/images/doc-logo.png [moved from doc/images/doc-logo.png with 100% similarity]
doc/html/images/doc-logo.svg [moved from doc/images/doc-logo.svg with 100% similarity]
doc/html/images/firefoxshare.png [moved from doc/images/firefoxshare.png with 100% similarity]
doc/html/images/rss-filter-1.png [moved from doc/images/rss-filter-1.png with 100% similarity]
doc/html/images/rss-filter-2.png [moved from doc/images/rss-filter-2.png with 100% similarity]
doc/html/img/favicon.ico [new file with mode: 0644]
doc/html/index.html [new file with mode: 0644]
doc/html/js/highlight.pack.js [new file with mode: 0644]
doc/html/js/jquery-2.1.1.min.js [new file with mode: 0644]
doc/html/js/modernizr-2.8.3.min.js [new file with mode: 0644]
doc/html/js/theme.js [new file with mode: 0644]
doc/html/mkdocs/js/lunr.min.js [new file with mode: 0644]
doc/html/mkdocs/js/mustache.min.js [new file with mode: 0644]
doc/html/mkdocs/js/require.js [new file with mode: 0644]
doc/html/mkdocs/js/search-results-template.mustache [new file with mode: 0644]
doc/html/mkdocs/js/search.js [new file with mode: 0644]
doc/html/mkdocs/js/text.js [new file with mode: 0644]
doc/html/mkdocs/search_index.json [new file with mode: 0644]
doc/html/search.html [new file with mode: 0644]
doc/html/sitemap.xml [new file with mode: 0644]
doc/md/3rd-party-libraries.md [moved from doc/3rd-party-libraries.md with 73% similarity]
doc/md/Backup,-restore,-import-and-export.md [moved from doc/Backup,-restore,-import-and-export.md with 87% similarity]
doc/md/Bookmarklet.md [moved from doc/Sharing-button.md with 76% similarity]
doc/md/Browsing-and-searching.md [moved from doc/Browsing-and-searching.md with 83% similarity]
doc/md/Coding-guidelines.md [moved from doc/Coding-guidelines.md with 64% similarity]
doc/md/Community-&-Related-software.md [moved from doc/Community-&-Related-software.md with 64% similarity]
doc/md/Continuous-integration-tools.md [new file with mode: 0644]
doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md [moved from doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md with 88% similarity]
doc/md/Create-and-serve-multiple-Shaarlis-(farm).md [moved from doc/Create-and-serve-multiple-Shaarlis-(farm).md with 77% similarity]
doc/md/Datastore-hacks.md [moved from doc/Datastore-hacks.md with 98% similarity]
doc/md/Development-guidelines.md [new file with mode: 0644]
doc/md/Directory-structure.md [moved from doc/Directory-structure.md with 98% similarity]
doc/md/Docker-101.md [new file with mode: 0644]
doc/md/Docker-resources.md [new file with mode: 0644]
doc/md/Download-CSS-styles-from-an-OPML-list.md [moved from doc/Download-CSS-styles-from-an-OPML-list.md with 92% similarity]
doc/md/Download-and-Installation.md [moved from doc/Download-and-Installation.md with 88% similarity]
doc/md/Example-patch---add-new-via-field-for-links.md [moved from doc/Example-patch---add-new-via-field-for-links.md with 80% similarity]
doc/md/FAQ.md [moved from doc/FAQ.md with 89% similarity]
doc/md/Features.md [moved from doc/Usage.md with 96% similarity]
doc/md/Firefox-share.md [moved from doc/Firefox-share.md with 86% similarity]
doc/md/GnuPG-signature.md [moved from doc/GnuPG-signature.md with 87% similarity]
doc/md/Plugin-System.md [moved from doc/Plugin-System.md with 88% similarity]
doc/md/Plugins.md [moved from doc/Plugins.md with 86% similarity]
doc/md/REST-API.md [new file with mode: 0644]
doc/md/RSS-feeds.md [moved from doc/RSS-feeds.md with 93% similarity]
doc/md/Release-Shaarli.md [moved from doc/Release-Shaarli.md with 74% similarity]
doc/md/Reverse-proxy-configuration.md [new file with mode: 0644]
doc/md/Security.md [moved from doc/Security.md with 99% similarity]
doc/md/Server-configuration.md [moved from doc/Server-configuration.md with 92% similarity]
doc/md/Server-requirements.md [moved from doc/Server-requirements.md with 73% similarity]
doc/md/Server-security.md [moved from doc/Server-security.md with 93% similarity]
doc/md/Shaarli-configuration.md [moved from doc/Shaarli-configuration.md with 90% similarity]
doc/md/Shaarli-images.md [new file with mode: 0644]
doc/md/Static-analysis.md [moved from doc/Static-analysis.md with 68% similarity]
doc/md/Theming.md [moved from doc/Theming.md with 79% similarity]
doc/md/Troubleshooting.md [moved from doc/Troubleshooting.md with 92% similarity]
doc/md/Unit-tests.md [moved from doc/Unit-tests.md with 96% similarity]
doc/md/Upgrade-and-migration.md [moved from doc/Upgrade-and-migration.md with 83% similarity]
doc/md/Versioning-and-Branches.md [new file with mode: 0644]
doc/md/_Footer.md [moved from doc/_Footer.md with 69% similarity]
doc/md/_Sidebar.md [new file with mode: 0644]
doc/md/config.json [new file with mode: 0644]
doc/md/github-markdown.css [new file with mode: 0644]
doc/md/images/bookmarklet.png [new file with mode: 0644]
doc/md/images/doc-logo.png [new file with mode: 0644]
doc/md/images/doc-logo.svg [new file with mode: 0644]
doc/md/images/firefoxshare.png [new file with mode: 0644]
doc/md/images/rss-filter-1.png [new file with mode: 0644]
doc/md/images/rss-filter-2.png [new file with mode: 0644]
doc/md/index.md [moved from doc/Home.md with 89% similarity]
doc/sidebar.html [deleted file]
mkdocs.yml [new file with mode: 0644]
tpl/default/page.footer.html