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/sidebar.html | |
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/sidebar.html')
-rw-r--r-- | doc/sidebar.html | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/doc/sidebar.html b/doc/sidebar.html deleted file mode 100644 index 478840d1..00000000 --- a/doc/sidebar.html +++ /dev/null | |||
@@ -1,52 +0,0 @@ | |||
1 | <div id="local-sidebar"> | ||
2 | <ul> | ||
3 | <li><a href="Home.html">Home</a></li> | ||
4 | <li>Setup | ||
5 | <ul> | ||
6 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
7 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
8 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
9 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
10 | <li><a href="Server-security.html">Server security</a></li> | ||
11 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
12 | <li><a href="Plugins.html">Plugins</a></li> | ||
13 | </ul></li> | ||
14 | <li><a href="Docker.html">Docker</a></li> | ||
15 | <li><a href="Usage.html">Usage</a> | ||
16 | <ul> | ||
17 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
18 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
19 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
20 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
21 | <li><a href="REST-API.html">REST API</a></li> | ||
22 | </ul></li> | ||
23 | <li>How To | ||
24 | <ul> | ||
25 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
26 | <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> | ||
27 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
28 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
29 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
30 | </ul></li> | ||
31 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
32 | <li><a href="Development.html">Development</a> | ||
33 | <ul> | ||
34 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
35 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
36 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
37 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
38 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
39 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
40 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
41 | <li><a href="Security.html">Security</a></li> | ||
42 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
43 | <li><a href="Theming.html">Theming</a></li> | ||
44 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
45 | </ul></li> | ||
46 | <li>About | ||
47 | <ul> | ||
48 | <li><a href="FAQ.html">FAQ</a></li> | ||
49 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
50 | </ul></li> | ||
51 | </ul> | ||
52 | </div> | ||