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/Sharing-button.html | |
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/Sharing-button.html')
-rw-r--r-- | doc/Sharing-button.html | 94 |
1 files changed, 0 insertions, 94 deletions
diff --git a/doc/Sharing-button.html b/doc/Sharing-button.html deleted file mode 100644 index f3682f8c..00000000 --- a/doc/Sharing-button.html +++ /dev/null | |||
@@ -1,94 +0,0 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <html> | ||
3 | <head> | ||
4 | <meta charset="utf-8"> | ||
5 | <meta name="generator" content="pandoc"> | ||
6 | <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> | ||
7 | <title>Shaarli – Sharing button</title> | ||
8 | <style type="text/css">code{white-space: pre;}</style> | ||
9 | <link rel="stylesheet" href="github-markdown.css"> | ||
10 | <!--[if lt IE 9]> | ||
11 | <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
12 | <![endif]--> | ||
13 | </head> | ||
14 | <body> | ||
15 | <div id="local-sidebar"> | ||
16 | <ul> | ||
17 | <li><a href="Home.html">Home</a></li> | ||
18 | <li>Setup | ||
19 | <ul> | ||
20 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> | ||
21 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
22 | <li><a href="Server-requirements.html">Server requirements</a></li> | ||
23 | <li><a href="Server-configuration.html">Server configuration</a></li> | ||
24 | <li><a href="Server-security.html">Server security</a></li> | ||
25 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | ||
26 | <li><a href="Plugins.html">Plugins</a></li> | ||
27 | </ul></li> | ||
28 | <li><a href="Docker.html">Docker</a></li> | ||
29 | <li><a href="Usage.html">Usage</a> | ||
30 | <ul> | ||
31 | <li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> | ||
32 | <li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li> | ||
33 | <li><a href="Firefox-share.html">Firefox share</a></li> | ||
34 | <li><a href="RSS-feeds.html">RSS feeds</a></li> | ||
35 | <li><a href="REST-API.html">REST API</a></li> | ||
36 | </ul></li> | ||
37 | <li>How To | ||
38 | <ul> | ||
39 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | ||
40 | <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> | ||
41 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | ||
42 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | ||
43 | <li><a href="Datastore-hacks.html">Datastore hacks</a></li> | ||
44 | </ul></li> | ||
45 | <li><a href="Troubleshooting.html">Troubleshooting</a></li> | ||
46 | <li><a href="Development.html">Development</a> | ||
47 | <ul> | ||
48 | <li><a href="GnuPG-signature.html">GnuPG signature</a></li> | ||
49 | <li><a href="Coding-guidelines.html">Coding guidelines</a></li> | ||
50 | <li><a href="Directory-structure.html">Directory structure</a></li> | ||
51 | <li><a href="3rd-party-libraries.html">3rd party libraries</a></li> | ||
52 | <li><a href="Plugin-System.html">Plugin System</a></li> | ||
53 | <li><a href="Release-Shaarli.html">Release Shaarli</a></li> | ||
54 | <li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li> | ||
55 | <li><a href="Security.html">Security</a></li> | ||
56 | <li><a href="Static-analysis.html">Static analysis</a></li> | ||
57 | <li><a href="Theming.html">Theming</a></li> | ||
58 | <li><a href="Unit-tests.html">Unit tests</a></li> | ||
59 | </ul></li> | ||
60 | <li>About | ||
61 | <ul> | ||
62 | <li><a href="FAQ.html">FAQ</a></li> | ||
63 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | ||
64 | </ul></li> | ||
65 | </ul> | ||
66 | </div> | ||
67 | <h1 id="sharing-button">Sharing button</h1> | ||
68 | <h3 id="add-the-sharing-button-bookmarklet-to-your-browser">Add the sharing button (<em>bookmarklet</em>) to your browser</h3> | ||
69 | <ul> | ||
70 | <li>Open your Shaarli and <code>Login</code></li> | ||
71 | <li>Click the <code>Tools</code> button in the top bar</li> | ||
72 | <li>Drag the <strong><code>✚Shaare link</code> button</strong>, and drop it to your browser's bookmarks bar.</li> | ||
73 | </ul> | ||
74 | <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> | ||
75 | <p><embed src="(images/bookmarklet.png).html" /></p> | ||
76 | <h3 id="share-links-using-the-bookmarklet">Share links using the <em>bookmarklet</em></h3> | ||
77 | <ul> | ||
78 | <li>When you are visiting a webpage you would like to share with Shaarli, click the <em>bookmarklet</em> you just added.</li> | ||
79 | <li>A window opens.</li> | ||
80 | <li>You can freely edit title, description, tags... to find it later using the text search or tag filtering.</li> | ||
81 | <li>You will be able to edit this link later using the <embed src="(https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png)-edit-button..html" /></li> | ||
82 | <li>You can also check the “Private” box so that the link is saved but only visible to you.</li> | ||
83 | <li>Click <code>Save</code>.<strong>Voilà! Your link is now shared.</strong></li> | ||
84 | </ul> | ||
85 | <h3 id="troubleshooting-the-bookmarklet-doesnt-work-with-a-few-website-e.g.-github.com">Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com)</h3> | ||
86 | <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> | ||
87 | <p>See <a href="https://github.com/shaarli/Shaarli#196">#196</a>.<a href=".html"></a></p> | ||
88 | <p>There is an open bug for both Firefox and Chromium:</p> | ||
89 | <ul> | ||
90 | <li><a href="https://bugzilla.mozilla.org/show_bug.cgi?id=866522" class="uri">https://bugzilla.mozilla.org/show_bug.cgi?id=866522</a></li> | ||
91 | <li><a href="https://code.google.com/p/chromium/issues/detail?id=233903" class="uri">https://code.google.com/p/chromium/issues/detail?id=233903</a></li> | ||
92 | </ul> | ||
93 | </body> | ||
94 | </html> | ||