aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/index.md
Commit message (Collapse)AuthorAgeFilesLines
* doc: fix homepage icondoc-fix-homepage-iconnodiscc2019-01-061-1/+1
| | | | The icon did not display properly on https://shaarli.readthedocs.io/en/master/
* documentation: refactor documentation homepagenodiscc2018-08-301-72/+48
| | | | | | | | - simplify/organize feature list and contributing section - move bug reporting/contact information to Contributing section - unclutter Ref https://github.com/shaarli/Shaarli/issues/1148#issuecomment-397871451 and https://github.com/shaarli/Shaarli/issues/598
* Fix broken documentation links and list formattingVirtualTam2018-06-261-5/+14
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Improve documentation (#598, #1105)nodiscc2018-06-171-30/+44
| | | | | | | | | | | | | | | | * rework/simplify server configuration/requirements pages (consolidate/simplify SSL/TLS/apache configuration) * update index.md introduction * remove external images (badges) * Fix COPYING link and documentation links * Update features list * dedpulicate information * remove server-requirements.md and move relevant doc to other files * TODO: rework nginx configuration (single configuration example, with commented out blocks for special cases) * TODO: consolidate download/install/configuration pages * remove blank lighttpd configuration section * remove Required? column for composer packages, all libraries are mandatory * php 7.2 compatibilty * clarify that certbot binary and paths may vary depending on install method
* doc: merge all sharing methods under a single "Sharing content" pagenodiscc2018-04-141-7/+0
| | | | | | | | | * formatting, wording, reordering, general improvements * move blog/pastebin/notepad item from index.md to this page * add TODOs * add the new page to mkdocs TOC Part of https://github.com/shaarli/Shaarli/issues/598
* doc: remove docker autobuild doc from index.mdnodiscc2017-12-091-12/+0
|
* move features.md info to index.mdnodiscc2017-12-091-8/+23
| | | Ref https://github.com/shaarli/Shaarli/issues/598
* Docker quickstart: one more grammar mistake. Made it a bit more terse.B. van Berkum2017-10-031-1/+1
|
* Typo's, unified structure a bit.B. van Berkum2017-10-031-2/+1
| | | | | | - Fixes inevitable typo that crept in. - Removed some blank lines, newlines, to match established whitespace use better. - Minor grammar improvement.
* Added docker quickstart example, with user-data volumeB. van Berkum2017-10-031-0/+12
|
* migrated Github wiki links to readthedocsWilli Eggeling2017-08-261-1/+1
|
* documentation: fix rendering and internal referencesVirtualTam2017-08-051-1/+2
| | | | | | | | | | | | | | | | | | | 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>
* move README contents to doc/md/index.mdnodiscc2017-06-181-3/+106
|
* Generate HTML documentation using MkDocs (WIP)nodiscc2017-06-181-0/+11
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 22:02:42 +0000