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/Browsing-and-searching.html | 83 ----------------------------------------- 1 file changed, 83 deletions(-) delete mode 100644 doc/Browsing-and-searching.html (limited to 'doc/Browsing-and-searching.html') diff --git a/doc/Browsing-and-searching.html b/doc/Browsing-and-searching.html deleted file mode 100644 index ef5b5245..00000000 --- a/doc/Browsing-and-searching.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Shaarli – Browsing and searching - - - - - - -

Browsing and searching

Browsing and Searching

Plain text search

Use the Search text field to search in any of the fields of all links (Title, URL, Description...)

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.

Exact text search: Use double-quotes (example "exact search") to search for the exact expression.

Both exclude patterns and exact searches can be combined with normal searches (example "exact search" term otherterm -notthis "very exact" stuff -notagain)

Tags search

Use the Filter by tags field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags).

Hidden tags: Tags starting with a dot . (example .secret) are private. They can only be seen and searched when logged in.

Alternatively you can use the Tag cloud to discover all tags and click on any of them to display related links.

To search for links that are not tagged, enter "" in the tag search field.

Filtering RSS feeds/Picture wall

RSS feeds can also be restricted to only return items matching a text/tag search: see RSS feeds.

- - -- cgit v1.2.3