From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: 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 --- doc/md/Firefox-share.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 doc/md/Firefox-share.md (limited to 'doc/md/Firefox-share.md') diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md new file mode 100644 index 00000000..9ba57b04 --- /dev/null +++ b/doc/md/Firefox-share.md @@ -0,0 +1,15 @@ +### Add Shaarli as a sharing service to Firefox + + * Open your Shaarli and `Login` + * Click the `Tools` button in the top bar + * Click the `✚Add to Firefox social` button and accept the activation. + + +### Sharing links using Firefox share + + * Add the sharing service as described above + * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] + * You can edit your link before and after saving, just like the bookmarklet above. + +|  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | +|------|-------------------------------------------------------------------------------| -- cgit v1.2.3 From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:32:30 +0200 Subject: make htmlpages --- doc/md/Firefox-share.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/md/Firefox-share.md') diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md index 9ba57b04..595b9400 100644 --- a/doc/md/Firefox-share.md +++ b/doc/md/Firefox-share.md @@ -8,7 +8,7 @@ ### Sharing links using Firefox share * Add the sharing service as described above - * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] + * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png) * You can edit your link before and after saving, just like the bookmarklet above. |  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | -- cgit v1.2.3 From 43ad7c8e825057747ccf02049050b323878952a7 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sat, 5 Aug 2017 11:56:24 +0200 Subject: 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 --- doc/md/Firefox-share.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) (limited to 'doc/md/Firefox-share.md') diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md index 595b9400..878884a4 100644 --- a/doc/md/Firefox-share.md +++ b/doc/md/Firefox-share.md @@ -1,15 +1,17 @@ ### Add Shaarli as a sharing service to Firefox - * Open your Shaarli and `Login` - * Click the `Tools` button in the top bar - * Click the `✚Add to Firefox social` button and accept the activation. +- Open your Shaarli and `Login` +- Click the `Tools` button in the top bar +- Click the `✚Add to Firefox social` button and accept the activation. ### Sharing links using Firefox share - * Add the sharing service as described above - * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png) - * You can edit your link before and after saving, just like the bookmarklet above. +- Add the sharing service as described above +- When you are visiting a webpage you would like to share with Shaarli, + click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png) +- You can edit your link before and after saving, just like the bookmarklet above. -|  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | -|------|-------------------------------------------------------------------------------| +_Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) +enabled server for Firefox Share to work. Firefox Share will not work over +plain HTTP connections._ -- cgit v1.2.3 From d0b8ffb9527feeea5a001ca9469e64a953375d63 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 9 Dec 2017 15:04:44 +0100 Subject: doc: note about firefox share compatibility --- doc/md/Firefox-share.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/md/Firefox-share.md') diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md index 878884a4..9a46b185 100644 --- a/doc/md/Firefox-share.md +++ b/doc/md/Firefox-share.md @@ -1,3 +1,6 @@ +| Note | Firefox Share is no longer available for Firefox 57 and later versions. | +|---------|---------| + ### Add Shaarli as a sharing service to Firefox - Open your Shaarli and `Login` -- cgit v1.2.3