aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* documentation: update 3rd-party resourcesVirtualTam2017-08-082-18/+30
| | | | | | 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-052-4/+19
| | | | | | | 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: remove obsolete doc release instructionsVirtualTam2017-08-051-20/+1
| | | | 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: 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>
* documentation: remove generated HTML from SCMVirtualTam2017-08-0265-19640/+0
| | | | | | Relates to https://github.com/shaarli/Shaarli/issues/908 Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Generate HTML documentationVirtualTam2017-07-2939-441/+452
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* docker: remove `dev` image, update documentationVirtualTam2017-07-298-379/+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/
* make htmlpagesnodiscc2017-07-044-47/+236
|
* 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-1850-1854/+92
|
* 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-18158-7103/+22044
| | | | | | | | | | | | | | | | | | | | | | | | 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
* Bump version to v0.9.0ArthurHoaro2017-05-0755-132/+1086
| | | | Signed-off-by: ArthurHoaro <arthur@hoa.ro>
* Bump version to v0.8.1ArthurHoaro2016-12-1210-33/+195
| | | | Signed-off-by: ArthurHoaro <arthur@hoa.ro>
* Bump version to v0.8.0ArthurHoaro2016-10-1258-996/+1434
| | | | Signed-off-by: ArthurHoaro <arthur@hoa.ro>
* Doc updateArthurHoaro2016-05-1445-194/+70
| | | | Signed-off-by: ArthurHoaro <arthur@hoa.ro>
* Update docs from WikiArthurHoaro2016-04-1461-626/+3433
|
* Doc: sync from Wiki, generate HTMLVirtualTam2015-09-0438-45/+289
| | | | | | | | | | | | | Additions: - Installation/Download: how to get Shaarli - Community software: ShaarliOS app Modifications: - Installation/Server requirements: PHP 5.4 EOL, PHP 7 announcements - Installation/Server configuration: improve Nginx security - Troubleshooting: PHP sessions on `free.fr` Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Doc: sync from Wiki, generate HTMLVirtualTam2015-08-1831-3/+128
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Doc: sync from Wiki, generate HTMLVirtualTam2015-08-0460-1198/+5471
| | | | | | | | | | | | | | | | Closes #291 Fixes #227 Modifications - HTML content: match the new Wiki structure - Makefile - generate a custom HTML sidebar - include the sidebar on all pages - infer and prepend page titles - handle relative links - add title metadata, e.g. Shaarli - <Page Name> Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* [doc] sync doc with latest wiki, build HTMLnodiscc2015-06-269-233/+443
|
* doc: remove old mdwiki index.htmlnodiscc2015-04-051-212/+0
|
* doc: sync doc/github-markdown.css from wikinodiscc2015-04-051-0/+277
|
* add local HTML documentationnodiscc2015-04-056-0/+907
| | | | generated with 'make htmldoc'
* doc: update documentation (sync from wiki)nodiscc2015-04-051-8/+55
|
* update docnodiscc2015-03-311-5/+23
|
* Display notes as absolute urls.feula2015-03-291-3/+0
| | | | | The deletion is related to Windows not handling quotes in filenames, see #179. It shouldn't delete the real file. Probably. Check it out.
* Include documentation/wiki locally:nodiscc2015-03-1413-0/+1025
* sync current wiki (https://github.com/shaarli/Shaarli/wiki) to the doc/ directory * fix missing logo in README * add link to local documentation in the page footer * add Makefile targets for doc generation by @virtualtam
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 20:20:02 +0000