diff options
author | nodiscc <nodiscc@gmail.com> | 2017-01-26 18:52:54 +0100 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2017-06-18 00:19:49 +0200 |
commit | 53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch) | |
tree | f8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Browsing-and-searching.md | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
download | Shaarli-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/md/Browsing-and-searching.md')
-rw-r--r-- | doc/md/Browsing-and-searching.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/md/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md new file mode 100644 index 00000000..ad62c2f0 --- /dev/null +++ b/doc/md/Browsing-and-searching.md | |||
@@ -0,0 +1,23 @@ | |||
1 | ## Plain text search | ||
2 | |||
3 | Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...) | ||
4 | |||
5 | **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. | ||
6 | |||
7 | **Exact text search:** Use double-quotes (example `"exact search"`) to search for the exact expression. | ||
8 | |||
9 | Both exclude patterns and exact searches can be combined with normal searches (example `"exact search" term otherterm -notthis "very exact" stuff -notagain`) | ||
10 | |||
11 | ## Tags search | ||
12 | |||
13 | Use the `Filter by tags` field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags). | ||
14 | |||
15 | **Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in. | ||
16 | |||
17 | Alternatively you can use the `Tag cloud` to discover all tags and click on any of them to display related links. | ||
18 | |||
19 | To search for links that are not tagged, enter `""` in the tag search field. | ||
20 | |||
21 | ## Filtering RSS feeds/Picture wall | ||
22 | |||
23 | RSS feeds can also be restricted to only return items matching a text/tag search: see [[RSS feeds]]. | ||