MyShaarli/doc/md/_Sidebar.md
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

46 lines
1.2 KiB
Markdown

- [[Home]]
- Setup
- [[Download and Installation]]
- [[Upgrade and migration]]
- [[Server requirements]]
- [[Server configuration]]
- [[Server security]]
- [[Shaarli configuration]]
- [[Plugins]]
- Docker
- [[Docker 101]]
- [[Shaarli images]]
- [[Reverse proxy configuration]]
- [[Docker resources]]
- Usage
- [[Features]]
- [[Bookmarklet]]
- [[Browsing and Searching]]
- [[Firefox share]]
- [[RSS feeds]]
- [[REST API]]
- How To
- [[Backup, restore, import and export]]
- [[Copy an existing installation over SSH and serve it locally]]
- [[Create and serve multiple Shaarlis (farm)]]
- [[Download CSS styles from an OPML list]]
- [[Datastore hacks]]
- [[Troubleshooting]]
- Development:
- [[Development guidelines]]
- [[Continuous integration tools]]
- [[GnuPG signature]]
- [[Coding guidelines]]
- [[Directory structure]]
- [[3rd party libraries]]
- [[Plugin System]]
- [[Release Shaarli]]
- [[Versioning and Branches]]
- [[Security]]
- [[Static analysis]]
- [[Theming]]
- [[Unit tests]]
- About
- [[FAQ]]
- [[Community & Related software]]