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/Bookmarklet.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/Bookmarklet.md')
-rw-r--r-- | doc/md/Bookmarklet.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/md/Bookmarklet.md b/doc/md/Bookmarklet.md new file mode 100644 index 00000000..265ced44 --- /dev/null +++ b/doc/md/Bookmarklet.md | |||
@@ -0,0 +1,30 @@ | |||
1 | ### Add the sharing button (_bookmarklet_) to your browser | ||
2 | |||
3 | * Open your Shaarli and `Login` | ||
4 | * Click the `Tools` button in the top bar | ||
5 | * Drag the **`✚Shaare link` button**, and drop it to your browser's bookmarks bar. | ||
6 | |||
7 | _This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar._ | ||
8 | |||
9 | ![](images/bookmarklet.png) | ||
10 | |||
11 | ### Share links using the _bookmarklet_ | ||
12 | |||
13 | * When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. | ||
14 | * A window opens. | ||
15 | * You can freely edit title, description, tags... to find it later using the text search or tag filtering. | ||
16 | * You will be able to edit this link later using the ![](https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png) edit button. | ||
17 | * You can also check the “Private” box so that the link is saved but only visible to you. | ||
18 | * Click `Save`.**Voilà! Your link is now shared.** | ||
19 | |||
20 | ### Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com) | ||
21 | |||
22 | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. | ||
23 | |||
24 | See [#196](https://github.com/shaarli/Shaarli#196). | ||
25 | |||
26 | There is an open bug for both Firefox and Chromium: | ||
27 | |||
28 | * https://bugzilla.mozilla.org/show_bug.cgi?id=866522 | ||
29 | * https://code.google.com/p/chromium/issues/detail?id=233903 | ||
30 | |||