53ed6d7d1e
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 |
||
|---|---|---|
| .github | ||
| application | ||
| cache | ||
| data | ||
| doc | ||
| docker | ||
| images | ||
| inc | ||
| pagecache | ||
| plugins | ||
| tests | ||
| tmp | ||
| tpl | ||
| .gitattributes | ||
| .gitignore | ||
| .htaccess | ||
| .travis.yml | ||
| AUTHORS | ||
| CHANGELOG.md | ||
| composer.json | ||
| composer.lock | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| Doxyfile | ||
| index.php | ||
| Makefile | ||
| mkdocs.yml | ||
| phpunit.xml | ||
| README.md | ||
| shaarli_version.php | ||
The personal, minimalist, super-fast, database free, bookmarking service.
Do you want to share the links you discover? Shaarli is a minimalist delicious clone that you can install on your own server. It is designed to be personal (single-user), fast and handy.
•
•
Quickstart
Demo
You can use this public demo instance of Shaarli. It runs the latest development version of Shaarli and is updated/reset daily.
Login: demo; Password: demo
Installation & upgrade
- Download and installation
- Upgrade and migration
- Server requirements
- Server configuration
- Shaarli configuration
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.