Commit graph

259 commits

Author SHA1 Message Date
VirtualTam
fcd900f7ce documentation: remove uneeded resources
Relates to https://github.com/shaarli/Shaarli/issues/312
Relates to https://github.com/shaarli/Shaarli/pull/772

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-02 14:48:41 +02:00
VirtualTam
84d0632a2d docker: remove dev image, update documentation
Relates to https://github.com/shaarli/Shaarli/issues/843

Changed:
- Update Docker image list
- Update Docker documentation structure

Removed:
- Delete Dockerfile and resources for the `dev` image
- Cleanup `doc/` resources

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-07-29 15:32:22 +02:00
nodiscc
6d074b4c90 doc: fix bullet list formatting
https://shaarli.readthedocs.io/en/master/Shaarli-configuration/
2017-07-20 19:52:39 +02:00
nodiscc
2f9c1ecf88 doc: release: update doc generation instructions 2017-07-04 21:26:01 +02:00
nodiscc
081a73486f doc: replace pandoc requirement with python3-venv 2017-06-18 22:22:34 +02:00
nodiscc
12e1877917 move README contents to doc/md/index.md 2017-06-18 22:15:50 +02:00
nodiscc
0433c688b9 make htmlpages 2017-06-18 06:32:30 +02:00
nodiscc
460ce50115 doc: rename "datastore hacks" -> "various hacks", move example scripts to gist.github.com, remove obsolete GH wiki _Sidebar.md 2017-06-18 06:29:15 +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