Home - Shaarli Documentation

From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: 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 --- doc/html/index.html | 344 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 344 insertions(+) create mode 100644 doc/html/index.html (limited to 'doc/html/index.html') diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 00000000..a9b0c7b9 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,344 @@ + + + + + + + + + + + Home - Shaarli Documentation + + + + + + + + + + + + + + + + + +

+ + +

+ Shaarli Documentation + +

+ + + +

+ +

+ + + + + +

+ +

Welcome to the Shaarli wiki!

Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.

For general info, read the README.

If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion (archive) or read the current issues. If you've found a bug, please create a new issue.

If you would like a feature added to Shaarli, check the issues labeled feature, enhancement, and plugin.

Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the doc/ directory of your Shaarli installation.

+ +

+ + +

+ +

+ + + GitHub + + + + Next » + + +

+ + + + + + -- cgit v1.2.3