diff options
| author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
|---|---|---|
| committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
| commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
| tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/Usage.md | |
| parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
| download | Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip | |
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
Diffstat (limited to 'doc/Usage.md')
| -rw-r--r-- | doc/Usage.md | 25 |
1 files changed, 0 insertions, 25 deletions
diff --git a/doc/Usage.md b/doc/Usage.md deleted file mode 100644 index 30ad1466..00000000 --- a/doc/Usage.md +++ /dev/null | |||
| @@ -1,25 +0,0 @@ | |||
| 1 | #Usage | ||
| 2 | ### Main features | ||
| 3 | Shaarli is intended: | ||
| 4 | * to share, comment and save interesting links and news | ||
| 5 | * to bookmark useful/frequent personal links (as private links) and share them between computers | ||
| 6 | * as a minimal blog/microblog/writing platform (no character limit) | ||
| 7 | * as a read-it-later list (for example items tagged `readlater`) | ||
| 8 | * to draft and save articles/ideas | ||
| 9 | * to keep code snippets | ||
| 10 | * to keep notes and documentation | ||
| 11 | * as a shared clipboard between machines | ||
| 12 | * as a todo list | ||
| 13 | * to store playlists (e.g. with the `music` or `video` tags) | ||
| 14 | * to keep extracts/comments from webpages that may disappear | ||
| 15 | * to keep track of ongoing discussions (for example items tagged `discussion`) | ||
| 16 | * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags[](.html) | ||
| 17 | * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) | ||
| 18 | |||
| 19 | ### Using Shaarli as a blog, notepad, pastebin... | ||
| 20 | |||
| 21 | * Go to your Shaarli setup and log in | ||
| 22 | * Click the `Add Link` button | ||
| 23 | * To share text only, do not enter any URL in the corresponding input field and click `Add Link` | ||
| 24 | * Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` | ||
| 25 | * Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. | ||