Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
MyShaarli/doc/md/Features.md
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

1.3 KiB
Raw Blame History

Main features

Shaarli is intended:

  • to share, comment and save interesting links and news
  • to bookmark useful/frequent personal links (as private links) and share them between computers
  • as a minimal blog/microblog/writing platform (no character limit)
  • as a read-it-later list (for example items tagged readlater)
  • to draft and save articles/ideas
  • to keep code snippets
  • to keep notes and documentation
  • as a shared clipboard between machines
  • as a todo list
  • to store playlists (e.g. with the music or video tags)
  • to keep extracts/comments from webpages that may disappear
  • to keep track of ongoing discussions (for example items tagged discussion)
  • to feed RSS aggregators (planets) with specific tags
  • to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...)

Using Shaarli as a blog, notepad, pastebin...

  • Go to your Shaarli setup and log in
  • Click the Add Link button
  • To share text only, do not enter any URL in the corresponding input field and click Add Link
  • Pick a title and enter your article, or note, in the description field; add a few tags; optionally check Private then click Save
  • Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink.