aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/index.md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam+github@flibidi.net>2018-06-28 12:52:50 +0200
committerGitHub <noreply@github.com>2018-06-28 12:52:50 +0200
commitd9a0b52276766604d6b3d96895ab1a79e4cd3218 (patch)
tree5b0973b5f5048aeff8287a22b9fcc806673e7197 /doc/md/index.md
parentc429f28ad46e6fa7472324e9ce81da01f55d8c9a (diff)
parent87f14312470ca51b936896b41413c96edfe3b18f (diff)
downloadShaarli-d9a0b52276766604d6b3d96895ab1a79e4cd3218.tar.gz
Shaarli-d9a0b52276766604d6b3d96895ab1a79e4cd3218.tar.zst
Shaarli-d9a0b52276766604d6b3d96895ab1a79e4cd3218.zip
Merge pull request #1167 from virtualtam/mkdocs
Improve Mkdocs build process, fix formatting issues
Diffstat (limited to 'doc/md/index.md')
-rw-r--r--doc/md/index.md19
1 files changed, 14 insertions, 5 deletions
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