From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: 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 --- doc/html/index.html | 344 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 344 insertions(+) create mode 100644 doc/html/index.html (limited to 'doc/html/index.html') diff --git a/doc/html/index.html b/doc/html/index.html new file mode 100644 index 00000000..a9b0c7b9 --- /dev/null +++ b/doc/html/index.html @@ -0,0 +1,344 @@ + + + + + + + + + + + Home - Shaarli Documentation + + + + + + + + + + + + + + + + + +

+ + +

+ Shaarli Documentation + +

+ + + +

+ +

+ + + + + +

+ +

Welcome to the Shaarli wiki!

Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.

For general info, read the README.

If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion (archive) or read the current issues. If you've found a bug, please create a new issue.

If you would like a feature added to Shaarli, check the issues labeled feature, enhancement, and plugin.

Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the doc/ directory of your Shaarli installation.

+ +

+ + +

+ +

+ + + GitHub + + + + Next » + + +

+ + + + + + -- cgit v1.2.3 From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:32:30 +0200 Subject: make htmlpages --- doc/html/index.html | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) (limited to 'doc/html/index.html') diff --git a/doc/html/index.html b/doc/html/index.html index a9b0c7b9..e6d4ef78 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -155,19 +155,7 @@

- Copy an existing installation over SSH and serve it locally -

- - Create and serve multiple Shaarlis (farm) -

- - Download CSS styles from an OPML list -

- - Datastore hacks + Various hacks

@@ -340,5 +328,5 @@ -- cgit v1.2.3 From 366247c84cdb0bb0457552468103814d4d31ce5c Mon Sep 17 00:00:00 2001 From: nodiscc Date: Tue, 4 Jul 2017 21:30:31 +0200 Subject: make htmlpages --- doc/html/index.html | 121 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 117 insertions(+), 4 deletions(-) (limited to 'doc/html/index.html') diff --git a/doc/html/index.html b/doc/html/index.html index e6d4ef78..93f4ba5d 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -53,6 +53,19 @@ Home

Shaarli documentation

Demo
Features
About

@@ -274,12 +287,112 @@

Welcome to the Shaarli wiki!

Shaarli documentation

Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.

For general info, read the README.

If you have any questions or ideas, please join the chat (also reachable via IRC), post them in our general discussion or read the current issues. +If you've found a bug, please create a new issue.

If you would like a feature added to Shaarli, check the issues labeled feature, enhancement, and plugin.

Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the doc/ directory of your Shaarli installation.

Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the doc/html/ directory of your Shaarli installation.

+ +

Demo

You can use this public demo instance of Shaarli. +It runs the latest development version of Shaarli and is updated/reset daily.

Features

Interface

minimalist design (simple is beautiful)
FAST
ATOM and RSS feeds
views:
- paginated link list
- tag cloud
- picture wall: image and video thumbnails
- daily: newspaper-like daily digest
- daily RSS feed
+
permalinks for easy reference
links can be public or private
extensible through plugins

Tag, view and search your links!

add a custom title and description to archived links
add tags to classify and search links
- features tag autocompletion, renaming, merging and deletion
+
full-text and tag search

Easy setup

dead-simple installation: drop the files, open the page
links are stored in a file
- compact storage
- no database required
- easy backup: simply copy the datastore file
+
import and export links as Netscape bookmarks

Accessibility

Firefox bookmarlet to share links in one click
support for mobile browsers
works with Javascript disabled
easy page customization through HTML/CSS/RainTPL

Security

bruteforce-proof login form
protected against XSRF +and session cookie hijacking

Goodies

thumbnail generation for images and video services: +dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
- lazy-loading with bLazy
+
PubSubHubbub protocol support
URL cleanup: automatic removal of ?utm_source=..., fb=...
discreet pop-up notification when a new release is available

REST API

Easily extensible by any client using the REST API exposed by Shaarli.

See the API documentation.

Other usages

Though Shaarli is primarily a bookmarking application, it can serve other purposes +(see usage examples): +- micro-blogging +- pastebin +- online notepad +- snippet archive

About

Shaarli community fork

This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli

This is a community fork of the original Shaarli project by Sébastien Sauvage.

The original project is currently unmaintained, and the developer has informed us +that he would have no time to work on Shaarli in the near future. +The Shaarli community has carried on the work to provide +many patches +for bug fixes and enhancements +in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.

Contributing

If you'd like to help, please: +- have a look at the open issues +and pull requests +- feel free to report bugs (feedback is much appreciated) +- suggest new features and improvements to both code and documentation +- propose solutions to existing problems +- submit pull requests :-)

License

Shaarli is Free Software. See COPYING for a detail of the contributors and licenses for each individual component.

@@ -328,5 +441,5 @@ -- cgit v1.2.3