Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
1084 commits 8 branches 1 tag 13 MiB
Commit graph

45 commits

Author SHA1 Message Date
VirtualTam
d691604080 docker: add alpine,debian,ubuntu test images 
Relates to https://github.com/shaarli/Shaarli/issues/843

Added:
- Makefile target to run commands in a Docker test context
- Docker images to run Shaarli test suites:
  - Alpine 3.6
  - Debian 8
  - Debian 9
  - Ubuntu 16.04
- Documentation

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-09-18 21:13:59 +02:00
VirtualTam
dc37a482ed Documentation+Makefile: update AUTHORS generation 
Fixes https://github.com/shaarli/Shaarli/issues/935

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-29 19:46:23 +02:00
VirtualTam
e4ed3a46b7 Merge pull request #944 from thewilli/configure-rememberme 
new setting: default value for 'remember me' checkbox
 2017-08-27 16:36:53 +02:00
Willi Eggeling
2e07e77573 new setting: default value for 'remember me' checkbox 
- the default state for the login page's 'remember me' checkbox can now be configured
- adapted the default and vintage theme to consider the new setting
- added documentation for the new setting
 2017-08-27 16:03:37 +02:00
VirtualTam
e8cef3ac43 Merge pull request #942 from thewilli/fix-wiki-links 
migrated Github wiki links to readthedocs
 2017-08-27 13:12:58 +02:00
Willi Eggeling
94c035ff71 removed doc and code references to magic quotes 
- removed all references to magic quotes
- magic quotes are not supported on PHP >= 5.4 (https://secure.php.net/manual/en/security.magicquotes.php)
- Shaarli does not support PHP < 5.5
 2017-08-26 11:27:18 +02:00
Willi Eggeling
cc8f572bc0 migrated Github wiki links to readthedocs 2017-08-26 09:40:57 +02:00
VirtualTam
d3fee4f40b documentation: update installation instructions for 0.9.1 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-23 01:22:07 +02:00
VirtualTam
92ccaea470 documentation: fix list formatting 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-23 00:57:50 +02:00
VirtualTam
57c628e195 documentation: update 3rd-party resources 
Relates to https://github.com/shaarli/Shaarli/issues/915

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-08 22:02:50 +02:00
VirtualTam
f320efd689 documentation: elaborate on REST API server & client prerequisites 
Relates to https://github.com/shaarli/Shaarli/issues/903
Relates to https://github.com/shaarli/Shaarli/issues/905

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 14:46:05 +02:00
VirtualTam
23daed648c documentation: remove obsolete doc release instructions 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 14:33:07 +02:00
VirtualTam
61f63d1086 documentation: add links to example REST API clients 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 14:30:43 +02:00
VirtualTam
e62486dd6a documentation: rewrite the REST API PHP client example 
Closes https://github.com/shaarli/Shaarli/issues/905
Relates to https://github.com/shaarli/Shaarli/pull/751
See https://shaarli.github.io/api-documentation/

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 14:15:59 +02:00
VirtualTam
7f876cf62b documentation: update release download and usage information 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 12:08:09 +02:00
VirtualTam
28439d63b8 documentation: remove duplicate "Coding guidelines" page 
The information is already present under "Static analysis"

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 12:05:15 +02:00
VirtualTam
43ad7c8e82 documentation: fix rendering and internal references 
This is mainly cleanup after switching from Github-flavoured Markdown
rendered by Github Pages, to standard Markdown rendered by MkDocs.

Changed:
- rephrase some section titles

Fixed:
- list rendering (items, sub-items))
- code rendering
- quotes
- dead links

Removed:
- extraneous navigational elements

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-05 11:56:24 +02:00
VirtualTam
fcd900f7ce documentation: remove uneeded resources 
Relates to https://github.com/shaarli/Shaarli/issues/312
Relates to https://github.com/shaarli/Shaarli/pull/772

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-02 14:48:41 +02:00
VirtualTam
9ff77362fe documentation: remove generated HTML from SCM 
Relates to https://github.com/shaarli/Shaarli/issues/908

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-08-02 14:48:41 +02:00
VirtualTam
3a6f91a9cc Generate HTML documentation 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-07-29 15:33:35 +02:00
VirtualTam
84d0632a2d docker: remove dev image, update documentation 
Relates to https://github.com/shaarli/Shaarli/issues/843

Changed:
- Update Docker image list
- Update Docker documentation structure

Removed:
- Delete Dockerfile and resources for the `dev` image
- Cleanup `doc/` resources

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2017-07-29 15:32:22 +02:00
nodiscc
6d074b4c90 doc: fix bullet list formatting 
https://shaarli.readthedocs.io/en/master/Shaarli-configuration/
 2017-07-20 19:52:39 +02:00
nodiscc
366247c84c make htmlpages 2017-07-04 21:30:31 +02:00
nodiscc
2f9c1ecf88 doc: release: update doc generation instructions 2017-07-04 21:26:01 +02:00
nodiscc
081a73486f doc: replace pandoc requirement with python3-venv 2017-06-18 22:22:34 +02:00
nodiscc
12e1877917 move README contents to doc/md/index.md 2017-06-18 22:15:50 +02:00
nodiscc
0433c688b9 make htmlpages 2017-06-18 06:32:30 +02:00
nodiscc
460ce50115 doc: rename "datastore hacks" -> "various hacks", move example scripts to gist.github.com, remove obsolete GH wiki _Sidebar.md 2017-06-18 06:29:15 +02:00
nodiscc
53ed6d7d1e 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
 2017-06-18 00:19:49 +02:00
ArthurHoaro
b230bf207d Bump version to v0.9.0 
Signed-off-by: ArthurHoaro <arthur@hoa.ro>
 2017-05-07 18:44:05 +02:00
ArthurHoaro
3cc8c89830 Bump version to v0.8.1 
Signed-off-by: ArthurHoaro <arthur@hoa.ro>
 2016-12-12 03:38:12 +01:00
ArthurHoaro
fdf88d1948 Bump version to v0.8.0 
Signed-off-by: ArthurHoaro <arthur@hoa.ro>
 2016-10-12 12:36:59 +02:00
ArthurHoaro
08dcd8ea58 Doc update 
Signed-off-by: ArthurHoaro <arthur@hoa.ro>
 2016-05-14 11:37:28 +02:00
ArthurHoaro
5409ade28c Update docs from Wiki 2016-04-14 15:18:25 +02:00
VirtualTam
f8b936e7e7 Doc: sync from Wiki, generate HTML 
Additions:
 - Installation/Download: how to get Shaarli
 - Community software: ShaarliOS app

Modifications:
 - Installation/Server requirements: PHP 5.4 EOL, PHP 7 announcements
 - Installation/Server configuration: improve Nginx security
 - Troubleshooting: PHP sessions on `free.fr`

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-09-04 21:32:25 +02:00
VirtualTam
6335a0fc0c Doc: sync from Wiki, generate HTML 
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-08-18 00:33:25 +02:00
VirtualTam
992af0b9d7 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>
 2015-08-04 16:02:21 +02:00
nodiscc
da9b0e3e80 [doc] sync doc with latest wiki, build HTML 2015-06-26 21:58:07 +02:00
nodiscc
6811469e75 doc: remove old mdwiki index.html 2015-04-05 22:41:40 +02:00
nodiscc
a57a12ef3c doc: sync doc/github-markdown.css from wiki 2015-04-05 22:38:57 +02:00
nodiscc
7a32b172b8 add local HTML documentation 
generated with 'make htmldoc'
 2015-04-05 22:37:15 +02:00
nodiscc
10070c3700 doc: update documentation (sync from wiki) 2015-04-05 22:18:04 +02:00
nodiscc
2f4ab7cae2 update doc 2015-03-31 20:21:21 +02:00
feula
3ea318dad0 Display notes as absolute urls. 
The deletion is related to Windows not handling quotes in filenames, see
 #179. It shouldn't delete the real file. Probably. Check it out.
 2015-03-29 17:31:38 +02:00
nodiscc
1acc87eeac Include documentation/wiki locally: 
* sync current wiki (https://github.com/shaarli/Shaarli/wiki) to the doc/ directory
 * fix missing logo in README
 * add link to local documentation in the page footer
 * add Makefile targets for doc generation by @virtualtam
 2015-03-14 18:40:11 +01:00