Commit graph

7 commits

Author SHA1 Message Date
VirtualTam
87f1431247 Fix broken documentation links and list formatting
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-06-26 22:22:33 +02:00
VirtualTam
57c628e195 documentation: update 3rd-party resources
Relates to https://github.com/shaarli/Shaarli/issues/915

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-08 22:02:50 +02:00
VirtualTam
f320efd689 documentation: elaborate on REST API server & client prerequisites
Relates to https://github.com/shaarli/Shaarli/issues/903
Relates to https://github.com/shaarli/Shaarli/issues/905

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:46:05 +02:00
VirtualTam
61f63d1086 documentation: add links to example REST API clients
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:30:43 +02:00
VirtualTam
e62486dd6a documentation: rewrite the REST API PHP client example
Closes https://github.com/shaarli/Shaarli/issues/905
Relates to https://github.com/shaarli/Shaarli/pull/751
See https://shaarli.github.io/api-documentation/

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 14:15:59 +02:00
VirtualTam
43ad7c8e82 documentation: fix rendering and internal references
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.

Changed:
- rephrase some section titles

Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links

Removed:
- extraneous navigational elements

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 11:56:24 +02:00
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