diff options
author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Firefox-share.md | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip |
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
Diffstat (limited to 'doc/md/Firefox-share.md')
-rw-r--r-- | doc/md/Firefox-share.md | 15 |
1 files changed, 15 insertions, 0 deletions
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 @@ | |||
1 | ### Add Shaarli as a sharing service to Firefox | ||
2 | |||
3 | * Open your Shaarli and `Login` | ||
4 | * Click the `Tools` button in the top bar | ||
5 | * Click the `✚Add to Firefox social` button and accept the activation. | ||
6 | |||
7 | |||
8 | ### Sharing links using Firefox share | ||
9 | |||
10 | * Add the sharing service as described above | ||
11 | * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] | ||
12 | * You can edit your link before and after saving, just like the bookmarklet above. | ||
13 | |||
14 | | | 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. | | ||
15 | |------|-------------------------------------------------------------------------------| | ||