diff options
author | VirtualTam <virtualtam@flibidi.net> | 2015-07-22 05:02:10 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2015-08-04 16:02:21 +0200 |
commit | 992af0b9d77cb4fbac2c37ef8d5896042d67a2a3 (patch) | |
tree | 4726baf18e7057eac3f9b6bdb5991fe6117814fc /doc/FAQ.md | |
parent | 96db105e4c0833324f7168edb5673278de8ccd54 (diff) | |
download | Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.gz Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.tar.zst Shaarli-992af0b9d77cb4fbac2c37ef8d5896042d67a2a3.zip |
Doc: sync from Wiki, generate HTML
Closes #291
Fixes #227
Modifications
- HTML content: match the new Wiki structure
- Makefile
- generate a custom HTML sidebar
- include the sidebar on all pages
- infer and prepend page titles
- handle relative links
- add title metadata, e.g. Shaarli - <Page Name>
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/FAQ.md')
-rw-r--r-- | doc/FAQ.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/FAQ.md b/doc/FAQ.md new file mode 100644 index 00000000..4c69763f --- /dev/null +++ b/doc/FAQ.md | |||
@@ -0,0 +1,44 @@ | |||
1 | #FAQ | ||
2 | ### Why did you create Shaarli ? | ||
3 | |||
4 | I 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).[](.html) | ||
5 | |||
6 | Enough 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. | ||
7 | |||
8 | ### Why use Shaarli and not Delicious/Diigo ? | ||
9 | |||
10 | With Shaarli: | ||
11 | |||
12 | * The data is yours: It's hosted on your server. | ||
13 | * Never fear of having your data locked-in. | ||
14 | * Never fear to have your data sold to third party. | ||
15 | * Your private links are not hosted on a third party server. | ||
16 | * You are not tracked by browser addons (like Diigo does) | ||
17 | * You can change the look and feel of the pages if you want. | ||
18 | * You can change the behaviour of the program. | ||
19 | * It's magnitude faster than most bookmarking services. | ||
20 | |||
21 | ### What does Shaarli mean? | ||
22 | |||
23 | Shaarli is for shaaring your links. | ||
24 | |||
25 | ### My Shaarli is broken! | ||
26 | First 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).[](.html) | ||
27 | |||
28 | If everything looks right but the issue(s) remain(s), please: | ||
29 | - take a look at the [troubleshooting](Troubleshooting) section[](.html) | ||
30 | - come [chat with us](https://gitter.im/shaarli/Shaarli) on Gitter, we'll be happy to help ;-)[](.html) | ||
31 | - browse active [issues](https://github.com/shaarli/Shaarli/issues) and [Pull Requests](https://github.com/shaarli/Shaarli/pulls)[](.html) | ||
32 | - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup) | ||
33 | - else, [open a new issue](https://github.com/shaarli/Shaarli/issues/new), and provide information about the problem:[](.html) | ||
34 | - _what happens?_ - display glitches, invalid data, security flaws... | ||
35 | - _what is your configuration?_ - OS, server version, activated extensions, web browser... | ||
36 | - _is it reproducible?_ | ||
37 | |||
38 | ### Why not use a real database? Files are slow! | ||
39 | |||
40 | Does browsing [this page](http://sebsauvage.net/links/) feel slow? Try browsing older pages, too.[](.html) | ||
41 | |||
42 | It'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? | ||
43 | |||
44 | The 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. | ||