Knah-Tsaeb
/
MyShaarli
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1,842 Commits 8 Branches 1 Tag 9.7 MiB
Commit Graph

19 Commits

Author SHA1 Message Date
nodiscc 2b4f391559 add "noindex, nofollow" HTML robots meta-tag to documentation pages 
- Customize the "readthedocs" mkdocs theme: https://www.mkdocs.org/user-guide/styling-your-docs/#customizing-a-theme
 - Adds a '<meta name="robots" content="noindex, nofollow">' HTML tag on each page
 - Do not include robots directive on readthedocs.org, only in local builds
 2018-09-09 16:21:03 +02:00
ArthurHoaro ad5f47adba
Merge pull request #687 from ArthurHoaro/web-thumb 
Use web-thumbnailer to retrieve thumbnails
 2018-07-28 09:41:29 +02:00
Aurélien Tamisier 8fdd65b884
Merge pull request #1168 from virtualtam/docker/compose 
Provide a Docker Compose example
 2018-07-27 19:25:52 +02:00
VirtualTam 9618e45f4b Disable MkDocs' strict mode for ReadTheDocs builds to pass 
Relates to https://github.com/shaarli/Shaarli/issues/1179

See:
- https://www.mkdocs.org/user-guide/configuration/#build-directories
- https://github.com/rtfd/readthedocs.org/issues/4314

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2018-07-24 23:55:09 +02:00
VirtualTam a0c34a4976 Docs: Add an installation guide for Debian 9 + Docker 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2018-07-12 22:50:30 +02:00
VirtualTam 1cafacfedd Docs: rename 'How-to' section to 'Guides' 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2018-07-12 21:48:48 +02:00
ArthurHoaro 8b5b7dcc83 Add Link structure page to the documentation 2018-07-05 20:31:35 +02:00
VirtualTam 972cd80085 Run MkDocs in strict mode 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2018-06-26 22:21:53 +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
nodiscc 80786e150d doc: merge all sharing methods under a single "Sharing content" page 
* 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
 2018-04-14 14:14:59 +02:00
nodiscc e2a2dc35c2
mkdocs.yml: move FAQ to top level, reorder, Move Community/related software to Usage 2017-12-26 18:44:14 +01:00
nodiscc bd6de61c52
remove Features.md entry in mkdocs.yml 2017-12-09 15:21:10 +01:00
ArthurHoaro 1a47014f99 Translation documentation 2017-10-22 13:16:59 +02:00
VirtualTam d691604080 docker: add alpine,debian,ubuntu test images 
Relates to https://github.com/shaarli/Shaarli/issues/843

Added:
- Makefile target to run commands in a Docker test context
- Docker images to run Shaarli test suites:
  - Alpine 3.6
  - Debian 8
  - Debian 9
  - Ubuntu 16.04
- Documentation

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-09-18 21:13:59 +02:00
VirtualTam 28439d63b8 documentation: remove duplicate "Coding guidelines" page 
The information is already present under "Static analysis"

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 12:05:15 +02:00
VirtualTam 1093ddeea2 documentation: set edit_uri 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-02 14:48:41 +02:00
VirtualTam 84d0632a2d docker: remove `dev` image, update documentation 
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>
 2017-07-29 15:32:22 +02:00
nodiscc 460ce50115 doc: rename "datastore hacks" -> "various hacks", move example scripts to gist.github.com, remove obsolete GH wiki _Sidebar.md 2017-06-18 06:29:15 +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