Commit graph

18 commits

Author SHA1 Message Date
nodiscc
58c2701e54 doc: fix broken markdown link
fixes https://github.com/shaarli/Shaarli/issues/1330
2019-08-01 19:09:05 +02:00
VirtualTam
e92676ace2 Update README, CHANGELOG and AUTHORS for v0.10.4
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2019-04-16 00:22:15 +02:00
VirtualTam
86dcb9048f Update badges, changelog and documentation for v0.10.3
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2019-02-24 15:44:12 +01:00
nodiscc
969ed87fb1
Merge pull request #1155 from shaarli/doc-improvements
Improve documentation (#598, #1105)
2018-06-21 19:34:11 +02:00
VirtualTam
6e1df6013e Update version badges and installation instructions
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-06-20 17:14:30 +02:00
nodiscc
bdfb967ca2 Improve documentation (#598, #1105)
* 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
2018-06-17 18:56:00 +02:00
ArthurHoaro
d7eb06bd7c Webpack / Documentation update 2018-03-28 19:04:40 +02:00
VirtualTam
ee242ae321 Documentation: release v0.9.6
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-03-25 20:11:10 +02:00
VirtualTam
f452d3c4df Update CHANGELOG, README badges and installation instructions
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2018-01-04 18:49:05 +01:00
nodiscc
7a205fb21c
doc: fix docker documentation link 2017-12-09 15:28:34 +01:00
nodiscc
76c3a4dbed documentation cleanup
* In preparation of #930 work
 * Remove/reorder duplicate documentation from Makefile/Unit-tests.md/Download-and-Installation.md (composer information is now in Unit-tests.md)
 * Installation using git: add composer requirement to all git installation procedures, add python3-virtualenv requirement
 * Styling (horizontal rulers, spacing, descriptive headers)
2017-11-18 16:22:43 +01:00
ArthurHoaro
2e6314af31 Merge pull request #1002 from ArthurHoaro/doc/install-docker
Docs: mention Docker in the download & install page
2017-10-22 14:56:26 +02:00
ArthurHoaro
1a47014f99 Translation documentation 2017-10-22 13:16:59 +02:00
ArthurHoaro
cfcc38192a Doc: mention Docker docs in the download & install page 2017-10-22 12:50:04 +02:00
VirtualTam
d3fee4f40b documentation: update installation instructions for 0.9.1
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-23 01:22:07 +02:00
VirtualTam
7f876cf62b documentation: update release download and usage information
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-05 12:08:09 +02:00
VirtualTam
43ad7c8e82 documentation: fix rendering and internal references
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>
2017-08-05 11:56:24 +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
Renamed from doc/Download-and-Installation.md (Browse further)