aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/FAQ.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/FAQ.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-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/FAQ.md')
-rw-r--r--doc/md/FAQ.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/md/FAQ.md b/doc/md/FAQ.md
new file mode 100644
index 00000000..151dcef5
--- /dev/null
+++ b/doc/md/FAQ.md
@@ -0,0 +1,43 @@
1### Why did you create Shaarli ?
2
3I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… **their Firefox addon sends to Diigo every single URL you visit** (Don't believe me ? Use [Tamper Data](https://addons.mozilla.org/en-US/firefox/addon/tamper-data/) and open any page).
4
5Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server.
6
7### Why use Shaarli and not Delicious/Diigo ?
8
9With Shaarli:
10
11* The data is yours: It's hosted on your server.
12* Never fear of having your data locked-in.
13* Never fear to have your data sold to third party.
14* Your private links are not hosted on a third party server.
15* You are not tracked by browser addons (like Diigo does)
16* You can change the look and feel of the pages if you want.
17* You can change the behaviour of the program.
18* It's magnitude faster than most bookmarking services.
19
20### What does Shaarli mean?
21
22Shaarli is for shaaring your links.
23
24### My Shaarli is broken!
25First of all, ensure that both the [web server](Server-configuration) and [Shaarli](Shaarli-configuration) are correctly configured, and that your installation is [supported](Server-requirements).
26
27If everything looks right but the issue(s) remain(s), please:
28- take a look at the [troubleshooting](Troubleshooting) section
29- come [chat with us](https://gitter.im/shaarli/Shaarli) on Gitter, we'll be happy to help ;-)
30- browse active [issues](https://github.com/shaarli/Shaarli/issues) and [Pull Requests](https://github.com/shaarli/Shaarli/pulls)
31 - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup)
32 - else, [open a new issue](https://github.com/shaarli/Shaarli/issues/new), and provide information about the problem:
33 - _what happens?_ - display glitches, invalid data, security flaws...
34 - _what is your configuration?_ - OS, server version, activated extensions, web browser...
35 - _is it reproducible?_
36
37### Why not use a real database? Files are slow!
38
39Does browsing [this page](http://sebsauvage.net/links/) feel slow? Try browsing older pages, too.
40
41It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why?
42
43The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time.