53ed6d7d1e
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
375 lines
13 KiB
HTML
375 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Bookmarklet - Shaarli Documentation</title>
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
<link href="../github-markdown.css" rel="stylesheet">
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Bookmarklet";
|
|
var mkdocs_page_input_path = "Bookmarklet.md";
|
|
var mkdocs_page_url = "/Bookmarklet/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js"></script>
|
|
<script src="../js/modernizr-2.8.3.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Shaarli Documentation</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="..">Home</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Setup</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Download-and-Installation/">Download and Installation</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-requirements/">Server requirements</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-configuration/">Server configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-security/">Server security</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Plugins/">Plugins</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Docker</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Docker-101/">Docker 101</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Shaarli-images/">Shaarli images</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Docker-resources/">Docker resources</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Usage</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Features/">Features</a>
|
|
</li>
|
|
<li class=" current">
|
|
|
|
<a class="current" href="./">Bookmarklet</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l3"><a href="#add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (bookmarklet) to your browser</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a href="#share-links-using-the-bookmarklet">Share links using the bookmarklet</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a href="#troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-eg-githubcom">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</a></li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Browsing-and-searching/">Browsing and searching</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Firefox-share/">Firefox share</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../RSS-feeds/">RSS feeds</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../REST-API/">REST API</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">How To</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Datastore-hacks/">Datastore hacks</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../Troubleshooting/">Troubleshooting</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Development</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Development-guidelines/">Development guidelines</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../GnuPG-signature/">GnuPG signature</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Coding-guidelines/">Coding guidelines</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Directory-structure/">Directory structure</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../3rd-party-libraries/">3rd party libraries</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Plugin-System/">Plugin System</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Release-Shaarli/">Release Shaarli</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Security/">Security</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Static-analysis/">Static analysis</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Theming/">Theming</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Unit-tests/">Unit tests</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">About</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../FAQ/">FAQ</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Community-&-Related-software/">Community & Related software</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Shaarli Documentation</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>Usage »</li>
|
|
|
|
|
|
|
|
<li>Bookmarklet</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/shaarli/Shaarli/edit/master/docs/Bookmarklet.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h3 id="add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (<em>bookmarklet</em>) to your browser</h3>
|
|
<ul>
|
|
<li>Open your Shaarli and <code>Login</code></li>
|
|
<li>Click the <code>Tools</code> button in the top bar</li>
|
|
<li>Drag the <strong><code>✚Shaare link</code> button</strong>, and drop it to your browser's bookmarks bar.</li>
|
|
</ul>
|
|
<p><em>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.</em></p>
|
|
<p><img alt="" src="../images/bookmarklet.png" /></p>
|
|
<h3 id="share-links-using-the-bookmarklet">Share links using the <em>bookmarklet</em></h3>
|
|
<ul>
|
|
<li>When you are visiting a webpage you would like to share with Shaarli, click the <em>bookmarklet</em> you just added.</li>
|
|
<li>A window opens.</li>
|
|
<li>You can freely edit title, description, tags... to find it later using the text search or tag filtering.</li>
|
|
<li>You will be able to edit this link later using the <img alt="" src="https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png" /> edit button.</li>
|
|
<li>You can also check the “Private” box so that the link is saved but only visible to you. </li>
|
|
<li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li>
|
|
</ul>
|
|
<h3 id="troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-eg-githubcom">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</h3>
|
|
<p>Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it.</p>
|
|
<p>See <a href="https://github.com/shaarli/Shaarli#196">#196</a>.</p>
|
|
<p>There is an open bug for both Firefox and Chromium:</p>
|
|
<ul>
|
|
<li>https://bugzilla.mozilla.org/show_bug.cgi?id=866522</li>
|
|
<li>https://code.google.com/p/chromium/issues/detail?id=233903</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../Browsing-and-searching/" class="btn btn-neutral float-right" title="Browsing and searching">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../Features/" class="btn btn-neutral" title="Features"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
|
|
<span><a href="../Features/" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="../Browsing-and-searching/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
</body>
|
|
</html>
|