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/_Sidebar.md | |
| 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/_Sidebar.md')
| -rw-r--r-- | doc/md/_Sidebar.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/md/_Sidebar.md b/doc/md/_Sidebar.md new file mode 100644 index 00000000..fe0e4229 --- /dev/null +++ b/doc/md/_Sidebar.md | |||
| @@ -0,0 +1,45 @@ | |||
| 1 | - [[Home]] | ||
| 2 | - Setup | ||
| 3 | - [[Download and Installation]] | ||
| 4 | - [[Upgrade and migration]] | ||
| 5 | - [[Server requirements]] | ||
| 6 | - [[Server configuration]] | ||
| 7 | - [[Server security]] | ||
| 8 | - [[Shaarli configuration]] | ||
| 9 | - [[Plugins]] | ||
| 10 | - Docker | ||
| 11 | - [[Docker 101]] | ||
| 12 | - [[Shaarli images]] | ||
| 13 | - [[Reverse proxy configuration]] | ||
| 14 | - [[Docker resources]] | ||
| 15 | - Usage | ||
| 16 | - [[Features]] | ||
| 17 | - [[Bookmarklet]] | ||
| 18 | - [[Browsing and Searching]] | ||
| 19 | - [[Firefox share]] | ||
| 20 | - [[RSS feeds]] | ||
| 21 | - [[REST API]] | ||
| 22 | - How To | ||
| 23 | - [[Backup, restore, import and export]] | ||
| 24 | - [[Copy an existing installation over SSH and serve it locally]] | ||
| 25 | - [[Create and serve multiple Shaarlis (farm)]] | ||
| 26 | - [[Download CSS styles from an OPML list]] | ||
| 27 | - [[Datastore hacks]] | ||
| 28 | - [[Troubleshooting]] | ||
| 29 | - Development: | ||
| 30 | - [[Development guidelines]] | ||
| 31 | - [[Continuous integration tools]] | ||
| 32 | - [[GnuPG signature]] | ||
| 33 | - [[Coding guidelines]] | ||
| 34 | - [[Directory structure]] | ||
| 35 | - [[3rd party libraries]] | ||
| 36 | - [[Plugin System]] | ||
| 37 | - [[Release Shaarli]] | ||
| 38 | - [[Versioning and Branches]] | ||
| 39 | - [[Security]] | ||
| 40 | - [[Static analysis]] | ||
| 41 | - [[Theming]] | ||
| 42 | - [[Unit tests]] | ||
| 43 | - About | ||
| 44 | - [[FAQ]] | ||
| 45 | - [[Community & Related software]] | ||