Commit graph

2191 commits

Author SHA1 Message Date
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
ArthurHoaro
4758c18164 Merge pull request #916 from ArthurHoaro/hotfix/fix-composer-php-version
Fix PHP version configuration in composer.json
2017-08-05 11:09:13 +02:00
ArthurHoaro
8911863019 Fix PHP version configuration in composer.json
Without this setting, composer would download dependencies depending on the PHP version installed on the system.
E.G. I was getting doctrine/instantiator 1.1, which requires at least PHP 7.1.
2017-08-05 10:59:39 +02:00
VirtualTam
b4ff0afb24 Merge pull request #910 from virtualtam/documentation/improvements
Include generated doc in release archives, remove HTML from SCM
2017-08-05 10:40:35 +02:00
ArthurHoaro
1fdb40fc16 Merge pull request #887 from ArthurHoaro/hotfix/dash-tag-rename
Make sure that the tag exists before altering/removing it
2017-08-05 09:59:03 +02:00
ArthurHoaro
3b67b22225 Move tag renaming code to LinkDB and unit test it 2017-08-05 09:55:20 +02:00
VirtualTam
f09e1e318e Merge pull request #889 from Lucas-C/master
Using only one form in linklist.html - fix #885
2017-08-03 16:27:59 +02:00
VirtualTam
f5568f87b1 Merge pull request #913 from virtualtam/fix/readme
readme: fix logo uri
2017-08-02 14:58:35 +02:00
VirtualTam
22760c5422 readme: fix logo uri
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-02 14:50:14 +02:00
VirtualTam
29712e905b documentation: include generated HTML in release archives
Closes https://github.com/shaarli/Shaarli/issues/908
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
1093ddeea2 documentation: set edit_uri
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-02 14:48:41 +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
c71c7e2bd4 Merge pull request #911 from virtualtam/fix/release/composer
fix: use pinned dependency revisions when generating release archives
2017-08-02 14:47:29 +02:00
VirtualTam
eaed9ce88e fix: use pinned dependency revisions when generating release archives
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-02 14:44:02 +02:00
VirtualTam
ce6bdab3a0 Merge pull request #912 from virtualtam/travis/precise
travis: explicitly set the build dist to `precise`
2017-08-02 14:40:49 +02:00
VirtualTam
64d748bbe4 travis: explicitly set the build dist to precise
See https://blog.travis-ci.com/2017-07-11-trusty-as-default-linux-is-coming

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
2017-08-01 19:39:45 +02:00
Lucas Cimon
f210d94f71 Using only one form in linklist.html + adding untaggedonly filter - fix #885 2017-07-30 16:19:34 +02:00
VirtualTam
fccfa09df8 Merge pull request #906 from virtualtam/docker/cleanup
docker: remove `dev` image, update documentation
2017-07-29 16:17:09 +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
VirtualTam
57ee53d6c6 Merge pull request #896 from ArthurHoaro/hotfix/firefox-social-subdir
Fix Firefox Social button in the default theme
2017-07-23 19:09:06 +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
96f70777f7 Merge pull request #901 from shaarli/fix-900
Remove merge conflict leftover
2017-07-19 18:54:00 +02:00
ArthurHoaro
2fee2f425d Merge pull request #899 from smuth4/master
Respect HTTP_X_FORWARDED_HOST
2017-07-13 14:15:06 +02:00
Stephen Muth
0b51ea7251 Add tests to cover new server_url behavior 2017-07-12 17:57:47 +00:00
nodiscc
a5fbc689f8 Remove merge conflict leftover
Fixes #900
2017-07-11 14:30:14 +02:00
Stephen Muth
b80315e238 Respect HTTP_X_FORWARDED_HOST
alongside _PORT and _PROTO
Fixes #879
2017-07-08 00:01:03 +00:00
nodiscc
70cb883547 doc: contributing: remove leftover link to wiki 2017-07-04 21:43:40 +02:00
nodiscc
5b25a9635f Merge pull request #772 from nodiscc/rtfd
Generate HTML documentation using MkDocs
2017-07-04 21:37:30 +02:00
nodiscc
8bf94136e1 makefile: remove [[link]] -> [link](url) conversion logic
all links in documentation have been converted to standard markdown link syntax
2017-07-04 21:30:50 +02:00
nodiscc
366247c84c make htmlpages 2017-07-04 21:30:31 +02:00
nodiscc
f47aa40c12 makefile: remove obsolete 'doc' target
official documentation can now be found in doc/md/
2017-07-04 21:26:27 +02:00
nodiscc
2f9c1ecf88 doc: release: update doc generation instructions 2017-07-04 21:26:01 +02:00
nodiscc
a6192bdd52 CONTRIBUTING.md: define new workflow for documentation edition and contributions 2017-07-04 21:24:44 +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
d5d22a6d07 Merge pull request #890 from Lucas-C/taglist-cloud_improvments
Tagcloud/list improvments
2017-06-11 14:14:59 +02:00
ArthurHoaro
8eb6bac137 Fix Firefox Social button in the default theme
is no longer required since the JS function is now in .
Also, include the trailing slash in the post URL.

Fixes #895
2017-06-11 14:09:42 +02:00
Lucas Cimon
49cc8e5d74 Tagcloud/list improvments 2017-06-09 10:58:12 +02:00
ArthurHoaro
88535f20a9 Merge pull request #894 from Lucas-C/bug893
Fixing "Uncaught TypeError" in shaarli.js - fix #893
2017-06-07 22:37:01 +02:00
Lucas Cimon
9bf82f4fa1 Fixing "Uncaught TypeError" in shaarli.js - fix #893 2017-06-07 16:10:24 +02:00
ArthurHoaro
d99aef535f Refactoring of CHANGETAG part to avoid duplicated code 2017-05-31 18:36:35 +02:00
ArthurHoaro
4c970f099f Make sure that the tag exists before altering/removing it
Fixes #886
2017-05-31 18:24:21 +02:00