diff options
-rw-r--r-- | .travis.yml | 9 | ||||
-rw-r--r-- | Dockerfile | 2 | ||||
-rw-r--r-- | Makefile | 2 | ||||
-rw-r--r-- | doc/md/FAQ.md | 4 | ||||
-rw-r--r-- | doc/md/REST-API.md | 5 | ||||
-rw-r--r-- | doc/md/Sharing-content.md | 26 | ||||
-rw-r--r-- | doc/md/index.md | 19 | ||||
-rw-r--r-- | index.php | 2 | ||||
-rw-r--r-- | mkdocs.yml | 3 |
9 files changed, 47 insertions, 25 deletions
diff --git a/.travis.yml b/.travis.yml index eee1ca74..cb81846f 100644 --- a/.travis.yml +++ b/.travis.yml | |||
@@ -28,6 +28,15 @@ matrix: | |||
28 | - yarn run build # Just to be sure that the build isn't broken | 28 | - yarn run build # Just to be sure that the build isn't broken |
29 | - make eslint | 29 | - make eslint |
30 | - make sasslint | 30 | - make sasslint |
31 | - language: python | ||
32 | python: 3.6 | ||
33 | cache: | ||
34 | directories: | ||
35 | - $HOME/.cache/pip | ||
36 | install: | ||
37 | - pip install mkdocs | ||
38 | script: | ||
39 | - mkdocs build --clean | ||
31 | 40 | ||
32 | cache: | 41 | cache: |
33 | directories: | 42 | directories: |
@@ -5,7 +5,7 @@ FROM python:3-alpine as docs | |||
5 | ADD . /usr/src/app/shaarli | 5 | ADD . /usr/src/app/shaarli |
6 | RUN cd /usr/src/app/shaarli \ | 6 | RUN cd /usr/src/app/shaarli \ |
7 | && pip install --no-cache-dir mkdocs \ | 7 | && pip install --no-cache-dir mkdocs \ |
8 | && mkdocs build | 8 | && mkdocs build --clean |
9 | 9 | ||
10 | # Stage 2: | 10 | # Stage 2: |
11 | # - Resolve PHP dependencies with Composer | 11 | # - Resolve PHP dependencies with Composer |
@@ -207,7 +207,7 @@ htmldoc: | |||
207 | python3 -m venv venv/ | 207 | python3 -m venv venv/ |
208 | bash -c 'source venv/bin/activate; \ | 208 | bash -c 'source venv/bin/activate; \ |
209 | pip install mkdocs; \ | 209 | pip install mkdocs; \ |
210 | mkdocs build' | 210 | mkdocs build --clean' |
211 | find doc/html/ -type f -exec chmod a-x '{}' \; | 211 | find doc/html/ -type f -exec chmod a-x '{}' \; |
212 | rm -r venv | 212 | rm -r venv |
213 | 213 | ||
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: | |||
22 | Shaarli stands for _shaaring_ your _links_. | 22 | Shaarli stands for _shaaring_ your _links_. |
23 | 23 | ||
24 | ### My Shaarli is broken! | 24 | ### My Shaarli is broken! |
25 | 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). | 25 | First of all, ensure that both the [web server](Server-configuration) and |
26 | [Shaarli](Shaarli-configuration) are correctly configured, and that your | ||
27 | installation is [supported](Server-configuration). | ||
26 | 28 | ||
27 | If everything looks right but the issue(s) remain(s), please: | 29 | If 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 @@ | |||
3 | See the [REST API documentation](http://shaarli.github.io/api-documentation/) | 3 | See the [REST API documentation](http://shaarli.github.io/api-documentation/) |
4 | for a list of available endpoints and parameters. | 4 | for a list of available endpoints and parameters. |
5 | 5 | ||
6 | Please ensure that your server meets the [requirements](Server-requirements) | 6 | Please ensure that your server meets the |
7 | and 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 @@ | |||
1 | Content posted to Shaarli is separated in items called _Shaares_. For each Shaare, | 1 | Content posted to Shaarli is separated in items called _Shaares_. For each Shaare, |
2 | you can customize the following aspects: | 2 | you 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 | ||
14 | While logged in to your Shaarli, you can add new Shaares in several ways: | 14 | While 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 | ||
36 | The _Bookmarklet_ \[[1](https://en.wikipedia.org/wiki/Bookmarklet)\] is a special | 36 | The _Bookmarklet_ \[[1](https://en.wikipedia.org/wiki/Bookmarklet)\] is a special |
37 | browser bookmark you can use to add new content to your Shaarli. This bookmarklet is | 37 | browser bookmark you can use to add new content to your Shaarli. This bookmarklet is |
38 | compatible with Firefox, Opera, Chrome and Safari. To set it up: | 38 | compatible 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 | ||
43 | Once this is done, you can shaare any URL you are visiting simply by clicking the | 43 | Once this is done, you can shaare any URL you are visiting simply by clicking the |
44 | bookmarklet in your browser! The same `New Shaare` dialog as above is displayed. | 44 | bookmarklet 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 | ||
62 | Once this is done, you can share any URL you are visiting by clicking the Firefox | 62 | Once 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 | ||
75 | Any Shaare can edited by clicking its ![](images/edit_icon.png) `Edit` button. | 75 | Any Shaare can edited by clicking its ![](images/edit_icon.png) `Edit` button. |
76 | 76 | ||
77 | Editing a Shaare will not change it's permalink, each permalink always points to the | 77 | Editing a Shaare will not change it's permalink, each permalink always points to the |
78 | latest revision of a Shaare. | 78 | latest 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 | ||
84 | While adding or editing a link, leave the URL field blank to create a text-only | 84 | While 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 |
86 | articles, private or public notes, snippets... There is no character limit! You can | 86 | articles, private or public notes, snippets... There is no character limit! You can |
87 | access your Shaare from its permalink. | 87 | access 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? | |||
6 | Shaarli is a minimalist link sharing service that you can install on your own server. | 6 | Shaarli is a minimalist link sharing service that you can install on your own server. |
7 | It is designed to be personal (single-user), fast and handy. | 7 | It is designed to be personal (single-user), fast and handy. |
8 | 8 | ||
9 | <!--- TODO screenshots ---> | 9 | <!-- TODO screenshots --> |
10 | 10 | ||
11 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. | 11 | Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. |
12 | For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). | 12 | For 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 | ||
31 | Login: `demo`; Password: `demo` | 31 | Login: `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 | ||
117 | The 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. | 117 | The 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 | ||
119 | The 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. | 119 | The Shaarli community has carried on the work to provide [many |
120 | patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for | ||
121 | [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) | ||
122 | in this repository, and will keep maintaining the project for the foreseeable | ||
123 | future, while keeping Shaarli simple and efficient. | ||
120 | 124 | ||
121 | 125 | ||
122 | ### Contributing | 126 | ### Contributing |
123 | 127 | ||
124 | If you'd like to help, please: | 128 | If 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) |
126 | and [pull requests](https://github.com/shaarli/Shaarli/pulls) | 131 | and [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 | ||
135 | Shaarli 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). | 140 | Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See |
141 | [COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail | ||
142 | of the contributors and licenses for each individual component. A list of | ||
143 | contributors is available | ||
144 | [here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS). | ||
136 | 145 | ||
@@ -48,7 +48,7 @@ if (! file_exists(__DIR__ . '/vendor/autoload.php')) { | |||
48 | ."If you installed Shaarli through Git or using the development branch,\n" | 48 | ."If you installed Shaarli through Git or using the development branch,\n" |
49 | ."please refer to the installation documentation to install PHP" | 49 | ."please refer to the installation documentation to install PHP" |
50 | ." dependencies using Composer:\n" | 50 | ." dependencies using Composer:\n" |
51 | ."- https://shaarli.readthedocs.io/en/master/Server-requirements/\n" | 51 | ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n" |
52 | ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/"; | 52 | ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/"; |
53 | exit; | 53 | exit; |
54 | } | 54 | } |
@@ -5,6 +5,7 @@ site_description: The personal, minimalist, super-fast, database free, bookmarki | |||
5 | theme: readthedocs | 5 | theme: readthedocs |
6 | docs_dir: doc/md | 6 | docs_dir: doc/md |
7 | site_dir: doc/html | 7 | site_dir: doc/html |
8 | strict: true | ||
8 | 9 | ||
9 | pages: | 10 | pages: |
10 | - Home: index.md | 11 | - Home: index.md |
@@ -23,7 +24,7 @@ pages: | |||
23 | - Usage: | 24 | - Usage: |
24 | - Browsing and searching: Browsing-and-searching.md | 25 | - Browsing and searching: Browsing-and-searching.md |
25 | - Sharing content: Sharing-content.md | 26 | - Sharing content: Sharing-content.md |
26 | - RSS feeds: RSS-feeds.md | 27 | - RSS feeds: RSS-feeds.md |
27 | - REST API: REST-API.md | 28 | - REST API: REST-API.md |
28 | - Community & Related software: Community-&-Related-software.md | 29 | - Community & Related software: Community-&-Related-software.md |
29 | - How To: | 30 | - How To: |