Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
MyShaarli/doc/md
History
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
..
images Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
3rd-party-libraries.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
_Footer.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
_Sidebar.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Backup,-restore,-import-and-export.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Bookmarklet.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Browsing-and-searching.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Coding-guidelines.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Community-&-Related-software.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
config.json Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Continuous-integration-tools.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Copy-an-existing-installation-over-SSH-and-serve-it-locally.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Create-and-serve-multiple-Shaarlis-(farm).md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Datastore-hacks.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Development-guidelines.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Directory-structure.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Docker-101.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Docker-resources.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Download-and-Installation.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Download-CSS-styles-from-an-OPML-list.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Example-patch---add-new-via-field-for-links.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
FAQ.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Features.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Firefox-share.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
github-markdown.css Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
GnuPG-signature.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
index.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Plugin-System.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Plugins.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Release-Shaarli.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
REST-API.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Reverse-proxy-configuration.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
RSS-feeds.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Security.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Server-configuration.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Server-requirements.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Server-security.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Shaarli-configuration.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Shaarli-images.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Static-analysis.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Theming.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Troubleshooting.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Unit-tests.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Upgrade-and-migration.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00
Versioning-and-Branches.md Generate HTML documentation using MkDocs (WIP) 2017-06-18 00:19:49 +02:00