aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/REST-API.md
Commit message (Collapse)AuthorAgeFilesLines
* Documentation - REST API - Mention dev.debug modeArthurHoaro2018-07-171-0/+19
|
* Fix broken documentation links and list formattingVirtualTam2018-06-261-2/+3
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: update 3rd-party resourcesVirtualTam2017-08-081-0/+5
| | | | | | Relates to https://github.com/shaarli/Shaarli/issues/915 Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: elaborate on REST API server & client prerequisitesVirtualTam2017-08-051-4/+18
| | | | | | | 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>
* 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: fix rendering and internal referencesVirtualTam2017-08-051-4/+4
| | | | | | | | | | | | | | | | | | | 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>
* Generate HTML documentation using MkDocs (WIP)nodiscc2017-06-181-0/+104
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-06-28 19:55:33 +0000