aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam@flibidi.net>2018-06-26 22:18:51 +0200
committerVirtualTam <virtualtam@flibidi.net>2018-06-26 22:22:33 +0200
commit87f14312470ca51b936896b41413c96edfe3b18f (patch)
tree5b0973b5f5048aeff8287a22b9fcc806673e7197 /doc/md
parent972cd800856942f71aae80d6ce119127843b0234 (diff)
downloadShaarli-87f14312470ca51b936896b41413c96edfe3b18f.tar.gz
Shaarli-87f14312470ca51b936896b41413c96edfe3b18f.tar.zst
Shaarli-87f14312470ca51b936896b41413c96edfe3b18f.zip
Fix broken documentation links and list formatting
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/md')
-rw-r--r--doc/md/FAQ.md4
-rw-r--r--doc/md/REST-API.md5
-rw-r--r--doc/md/Sharing-content.md26
-rw-r--r--doc/md/index.md19
4 files changed, 33 insertions, 21 deletions
diff --git a/doc/md/FAQ.md b/doc/md/FAQ.md
index 77faf117..a2ec7d57 100644
--- a/doc/md/FAQ.md
+++ b/doc/md/FAQ.md
@@ -22,7 +22,9 @@ With Shaarli:
22Shaarli stands for _shaaring_ your _links_. 22Shaarli stands for _shaaring_ your _links_.
23 23
24### My Shaarli is broken! 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). 25First of all, ensure that both the [web server](Server-configuration) and
26[Shaarli](Shaarli-configuration) are correctly configured, and that your
27installation is [supported](Server-configuration).
26 28
27If everything looks right but the issue(s) remain(s), please: 29If everything looks right but the issue(s) remain(s), please:
28 30
diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md
index 68a83c00..c016de56 100644
--- a/doc/md/REST-API.md
+++ b/doc/md/REST-API.md
@@ -3,8 +3,9 @@
3See the [REST API documentation](http://shaarli.github.io/api-documentation/) 3See the [REST API documentation](http://shaarli.github.io/api-documentation/)
4for a list of available endpoints and parameters. 4for a list of available endpoints and parameters.
5 5
6Please ensure that your server meets the [requirements](Server-requirements) 6Please ensure that your server meets the
7and is properly [configured](Server-configuration): 7[requirements](Server-configuration#prerequisites) and is properly
8[configured](Server-configuration):
8 9
9- URL rewriting is enabled (see specific Apache and Nginx sections) 10- URL rewriting is enabled (see specific Apache and Nginx sections)
10- the server's timezone is properly defined 11- the server's timezone is properly defined
diff --git a/doc/md/Sharing-content.md b/doc/md/Sharing-content.md
index faacc1f9..4910ff6c 100644
--- a/doc/md/Sharing-content.md
+++ b/doc/md/Sharing-content.md
@@ -1,4 +1,4 @@
1Content posted to Shaarli is separated in items called _Shaares_. For each Shaare, 1Content posted to Shaarli is separated in items called _Shaares_. For each Shaare,
2you can customize the following aspects: 2you can customize the following aspects:
3 3
4 * URL to link to 4 * URL to link to
@@ -13,10 +13,10 @@ you can customize the following aspects:
13 13
14While logged in to your Shaarli, you can add new Shaares in several ways: 14While logged in to your Shaarli, you can add new Shaares in several ways:
15 15
16 * [+Shaare button] 16 * [+Shaare button](#shaare-button)
17 * [Bookmarklet] 17 * [Bookmarklet](#bookmarklet)
18 * [Firefox Share](#firefox-share) 18 * [Firefox Share](#firefox-share)
19 * Third-party [apps and browser addons](Community-\&-Related-software.md#mobile-apps) 19 * Third-party [apps and browser addons](Community-&-Related-software.md#mobile-apps)
20 * [REST API](https://shaarli.github.io/api-documentation/) 20 * [REST API](https://shaarli.github.io/api-documentation/)
21 21
22### +Shaare button 22### +Shaare button
@@ -33,14 +33,14 @@ While logged in to your Shaarli, you can add new Shaares in several ways:
33 33
34### Bookmarklet 34### Bookmarklet
35 35
36The _Bookmarklet_ \[[1](https://en.wikipedia.org/wiki/Bookmarklet)\] is a special 36The _Bookmarklet_ \[[1](https://en.wikipedia.org/wiki/Bookmarklet)\] is a special
37browser bookmark you can use to add new content to your Shaarli. This bookmarklet is 37browser bookmark you can use to add new content to your Shaarli. This bookmarklet is
38compatible with Firefox, Opera, Chrome and Safari. To set it up: 38compatible with Firefox, Opera, Chrome and Safari. To set it up:
39 39
40 * Access the `Tools` page from the button in the toolbar. 40 * Access the `Tools` page from the button in the toolbar.
41 * Drag the **`✚Shaare link` button** to your browser's bookmarks bar. 41 * Drag the **`✚Shaare link` button** to your browser's bookmarks bar.
42 42
43Once this is done, you can shaare any URL you are visiting simply by clicking the 43Once this is done, you can shaare any URL you are visiting simply by clicking the
44bookmarklet in your browser! The same `New Shaare` dialog as above is displayed. 44bookmarklet in your browser! The same `New Shaare` dialog as above is displayed.
45 45
46| Note | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunately, there is nothing Shaarli can do about it. \[[1](https://github.com/shaarli/Shaarli/issues/196)]\ \[[2](https://bugzilla.mozilla.org/show_bug.cgi?id=866522)]\ \[[3](https://code.google.com/p/chromium/issues/detail?id=233903)]\ | 46| Note | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunately, there is nothing Shaarli can do about it. \[[1](https://github.com/shaarli/Shaarli/issues/196)]\ \[[2](https://bugzilla.mozilla.org/show_bug.cgi?id=866522)]\ \[[3](https://code.google.com/p/chromium/issues/detail?id=233903)]\ |
@@ -59,8 +59,8 @@ Before using Firefox Share, you must first add Shaarli as a sharing provider:
59- Click the `Tools` button in the top bar 59- Click the `Tools` button in the top bar
60- Click the `✚Add to Firefox social` button and accept the activation. 60- Click the `✚Add to Firefox social` button and accept the activation.
61 61
62Once this is done, you can share any URL you are visiting by clicking the Firefox 62Once this is done, you can share any URL you are visiting by clicking the Firefox
63_Share_ button [images/firefoxshare.png](images/firefoxshare.png) 63_Share_ button ![images/firefoxshare.png](images/firefoxshare.png)
64 64
65| Note | Firefox Share is no longer available for Firefox 57 and later versions. | 65| Note | Firefox Share is no longer available for Firefox 57 and later versions. |
66|---------|---------| 66|---------|---------|
@@ -74,15 +74,15 @@ _Share_ button [images/firefoxshare.png](images/firefoxshare.png)
74 74
75Any Shaare can edited by clicking its ![](images/edit_icon.png) `Edit` button. 75Any Shaare can edited by clicking its ![](images/edit_icon.png) `Edit` button.
76 76
77Editing a Shaare will not change it's permalink, each permalink always points to the 77Editing a Shaare will not change it's permalink, each permalink always points to the
78latest revision of a Shaare. 78latest revision of a Shaare.
79 79
80-------------------------------------------------------------------------------- 80--------------------------------------------------------------------------------
81 81
82## Using shaarli as a blog, notepad, pastebin... 82## Using shaarli as a blog, notepad, pastebin...
83 83
84While adding or editing a link, leave the URL field blank to create a text-only 84While adding or editing a link, leave the URL field blank to create a text-only
85("note") post. This allows you to post any kind of text content, such as blog 85("note") post. This allows you to post any kind of text content, such as blog
86articles, private or public notes, snippets... There is no character limit! You can 86articles, private or public notes, snippets... There is no character limit! You can
87access your Shaare from its permalink. 87access your Shaare from its permalink.
88 88
diff --git a/doc/md/index.md b/doc/md/index.md
index 21a63d3c..c18332b4 100644
--- a/doc/md/index.md
+++ b/doc/md/index.md
@@ -6,7 +6,7 @@ Do you want to share the links you discover?
6Shaarli is a minimalist link sharing service that you can install on your own server. 6Shaarli is a minimalist link sharing service that you can install on your own server.
7It is designed to be personal (single-user), fast and handy. 7It is designed to be personal (single-user), fast and handy.
8 8
9<!--- TODO screenshots ---> 9<!-- TODO screenshots -->
10 10
11Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. 11Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
12For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). 12For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
@@ -30,7 +30,7 @@ It runs the latest development version of Shaarli and is updated/reset daily.
30 30
31Login: `demo`; Password: `demo` 31Login: `demo`; Password: `demo`
32 32
33<!---- TODO review everything below this point ---> 33<!-- TODO review everything below this point -->
34 34
35 35
36## Features 36## Features
@@ -98,7 +98,7 @@ Shaarli can be used:
98- bruteforce protection on the login form 98- bruteforce protection on the login form
99- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking 99- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking
100 100
101<!---- TODO Limitations ---> 101<!-- TODO Limitations -->
102 102
103### REST API 103### REST API
104 104
@@ -116,12 +116,17 @@ This is a community fork of the original [Shaarli](https://github.com/sebsauvage
116 116
117The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would have no time to work on Shaarli in the near future. 117The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would have no time to work on Shaarli in the near future.
118 118
119The Shaarli community has carried on the work to provide [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. 119The Shaarli community has carried on the work to provide [many
120patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for
121[bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
122in this repository, and will keep maintaining the project for the foreseeable
123future, while keeping Shaarli simple and efficient.
120 124
121 125
122### Contributing 126### Contributing
123 127
124If you'd like to help, please: 128If you'd like to help, please:
129
125- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) 130- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
126and [pull requests](https://github.com/shaarli/Shaarli/pulls) 131and [pull requests](https://github.com/shaarli/Shaarli/pulls)
127- feel free to report bugs (feedback is much appreciated) 132- feel free to report bugs (feedback is much appreciated)
@@ -132,5 +137,9 @@ and [pull requests](https://github.com/shaarli/Shaarli/pulls)
132 137
133### License 138### License
134 139
135Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail of the contributors and licenses for each individual component. A list of contributors is available [here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS). 140Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See
141[COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail
142of the contributors and licenses for each individual component. A list of
143contributors is available
144[here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS).
136 145