aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Browsing-and-searching.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/Browsing-and-searching.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-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/Browsing-and-searching.md')
-rw-r--r--doc/Browsing-and-searching.md28
1 files changed, 0 insertions, 28 deletions
diff --git a/doc/Browsing-and-searching.md b/doc/Browsing-and-searching.md
deleted file mode 100644
index 854b6b60..00000000
--- a/doc/Browsing-and-searching.md
+++ /dev/null
@@ -1,28 +0,0 @@
1#Browsing and searching
2# Browsing and Searching
3
4![(http://pix.toile-libre.org/upload/original/1455571378.png)]((http://pix.toile-libre.org/upload/original/1455571378.png).html)
5
6## Plain text search
7
8Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...)
9
10**Exclude text/tags:** Use the `-` operator before a word or tag (example `-uninteresting`) to prevent entries containing (or tagged) `uninteresting` from showing up in the search results.
11
12**Exact text search:** Use double-quotes (example `"exact search"`) to search for the exact expression.
13
14Both exclude patterns and exact searches can be combined with normal searches (example `"exact search" term otherterm -notthis "very exact" stuff -notagain`)
15
16## Tags search
17
18Use the `Filter by tags` field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags).
19
20**Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in.
21
22Alternatively you can use the `Tag cloud` to discover all tags and click on any of them to display related links.
23
24To search for links that are not tagged, enter `""` in the tag search field.
25
26## Filtering RSS feeds/Picture wall
27
28RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS-feeds.html).