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/Bookmarklet.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 doc/md/Bookmarklet.md (limited to 'doc/md/Bookmarklet.md') 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 @@ +### Add the sharing button (_bookmarklet_) to your browser + + * Open your Shaarli and `Login` + * Click the `Tools` button in the top bar + * Drag the **`✚Shaare link` button**, and drop it to your browser's bookmarks bar. + +_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._ + +![](images/bookmarklet.png) + +### Share links using the _bookmarklet_ + + * When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. + * A window opens. + * You can freely edit title, description, tags... to find it later using the text search or tag filtering. + * You will be able to edit this link later using the ![](https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png) edit button. + * You can also check the “Private” box so that the link is saved but only visible to you. + * Click `Save`.**Voilà! Your link is now shared.** + +### Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com) + +Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. + +See [#196](https://github.com/shaarli/Shaarli#196). + +There is an open bug for both Firefox and Chromium: + + * https://bugzilla.mozilla.org/show_bug.cgi?id=866522 + * https://code.google.com/p/chromium/issues/detail?id=233903 + -- cgit v1.2.3