aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md
Commit message (Collapse)AuthorAgeFilesLines
...
* documentation: add links to example REST API clientsVirtualTam2017-08-051-1/+14
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: rewrite the REST API PHP client exampleVirtualTam2017-08-051-20/+37
| | | | | | | | 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>
* documentation: update release download and usage informationVirtualTam2017-08-052-6/+4
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: remove duplicate "Coding guidelines" pageVirtualTam2017-08-051-6/+0
| | | | | | The information is already present under "Static analysis" Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: fix rendering and internal referencesVirtualTam2017-08-0529-323/+373
| | | | | | | | | | | | | | | | | | | 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>
* documentation: remove uneeded resourcesVirtualTam2017-08-023-294/+0
| | | | | | | 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>
* docker: remove `dev` image, update documentationVirtualTam2017-07-294-1/+0
| | | | | | | | | | | | | | 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>
* doc: fix bullet list formattingnodiscc2017-07-201-0/+2
| | | https://shaarli.readthedocs.io/en/master/Shaarli-configuration/
* doc: release: update doc generation instructionsnodiscc2017-07-041-2/+2
|
* doc: replace pandoc requirement with python3-venvnodiscc2017-06-181-1/+2
|
* move README contents to doc/md/index.mdnodiscc2017-06-181-3/+106
|
* make htmlpagesnodiscc2017-06-188-18/+18
|
* doc: rename "datastore hacks" -> "various hacks", move example scripts to ↵nodiscc2017-06-186-512/+9
| | | | gist.github.com, remove obsolete GH wiki _Sidebar.md
* Generate HTML documentation using MkDocs (WIP)nodiscc2017-06-1850-0/+4509
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
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-02 14:01:15 +0000