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
64 lines
3 KiB
Markdown
64 lines
3 KiB
Markdown
|
|
* [Backup and restore the datastore file](#backup-and-restore-the-datastore-file)
|
|
* [Export links as...](#export-links-as)
|
|
* [Import links from...](#import-links-from)
|
|
* [Import Shaarli links to Firefox](#import-shaarli-links-to-firefox)
|
|
|
|
----------------------
|
|
|
|
## Backup and restore the datastore file
|
|
|
|
Backup the file `data/datastore.php` (by FTP or SSH). Restore by putting the file back in place.
|
|
|
|
Example command:
|
|
```bash
|
|
rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php
|
|
```
|
|
|
|
## Export links as...
|
|
|
|
To export links as an HTML file, under _Tools > Export_, choose:
|
|
- _Export all_ to export both public and private links
|
|
- _Export public_ to export public links only
|
|
- _Export private_ to export private links only
|
|
|
|
Restore by using the `Import` feature.
|
|
* This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool.
|
|
|
|
Example command:
|
|
```bash
|
|
./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all
|
|
```
|
|
|
|
## Import links from...
|
|
|
|
### Diigo
|
|
|
|
If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)
|
|
|
|
### Mister Wong
|
|
|
|
See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks.
|
|
|
|
### SemanticScuttle
|
|
|
|
To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase).
|
|
|
|
### Scuttle
|
|
|
|
Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.
|
|
|
|
## Import Shaarli links to Firefox
|
|
|
|
* Export your Shaarli links as described above.
|
|
* For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)`
|
|
* In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`)
|
|
* Select `Import and Backup > Import bookmarks in HTML format`
|
|
|
|
Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time.
|
|
|
|
You may be interested in these Firefox addons to manage links imported from Shaarli
|
|
|
|
* [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks
|
|
* [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags
|