Mercurial > wikked

comparison docs/pages/03_configuration.md @ 383:c19b8cc11938

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Add information about the `ignore` section, and more wiki options.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 04 Oct 2015 08:14:20 -0700
parents 3a61f45702cb
children dcaa41b39c23
comparison
equal deleted inserted replaced
382:3a61f45702cb 383:c19b8cc11938
41 41
42 * `main_page` (defaults to `Main page`): the name of the page that should be 42 * `main_page` (defaults to `Main page`): the name of the page that should be
43 displayed when people visit the root URL of your wiki. Page names are case 43 displayed when people visit the root URL of your wiki. Page names are case
44 sensitive so watch out for the capitalization. 44 sensitive so watch out for the capitalization.
45 45
46 * `default_extension` (defaults to `md`): the file extension (and therefore
47 formatting engine) to use by default when creating a new page. The default
48 values is `md` for [Markdown][].
49
46 * `templates_dir` (defaults to `Templates`): by default, the `include` statement 50 * `templates_dir` (defaults to `Templates`): by default, the `include` statement
47 (see the [syntax page][2]) will first look into a templates directory for 51 (see the [syntax page][2]) will first look into a templates directory for
48 a template of the given name. This is the name of that folder. 52 a template of the given name. This is the name of that folder.
49 53
50 * `indexer` (defaults to `whoosh`): The full-text indexer to use. Only 2 indexers are currently 54 * `indexer` (defaults to `whoosh`): The full-text indexer to use. Only 2 indexers are currently
64 [3]: http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls 68 [3]: http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls
65 [SQLite]: http://sqlite.org 69 [SQLite]: http://sqlite.org
66 [SQLAlchemy]: http://sqlalchemy.org 70 [SQLAlchemy]: http://sqlalchemy.org
67 [whoosh]: https://bitbucket.org/mchaput/whoosh/wiki/Home 71 [whoosh]: https://bitbucket.org/mchaput/whoosh/wiki/Home
68 [elastic]: http://www.elasticsearch.org/ 72 [elastic]: http://www.elasticsearch.org/
73 [markdown]: http://daringfireball.net/projects/markdown/
69 74
70 75
71 ## Permissions 76 ## Permissions
72 77
73 The `wikirc` file can also be used to define user permissions. This is done with 78 The `wikirc` file can also be used to define user permissions. This is done with
107 112
108 {%raw%} 113 {%raw%}
109 {{readers: *,anonymous}} 114 {{readers: *,anonymous}}
110 {%endraw%} 115 {%endraw%}
111 116
117
118 ## Ignored files
119
120 The optional `ignore` section lets you define files or folders for Wikked to
121 ignore (_i.e._ files that are not pages, or folder that don't contain pages).
122
123 Each item in this section should be `name = pattern`, where `name` is irrelevant,
124 and `pattern` is a glob-like pattern:
125
126 [ignore]
127 venv = venv
128 temp = *~
129 temp2 = *.swp
130
131 This will ignore a `venv` folder or file at the root, or any file or folder
132 anywhere that ends with `~` or `.swp`.
133
134