Mercurial > wikked
changeset 383:c19b8cc11938
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 | 93a2f7c86059 |
| files | docs/pages/03_configuration.md |
| diffstat | 1 files changed, 23 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/pages/03_configuration.md Sun Oct 04 08:02:43 2015 -0700 +++ b/docs/pages/03_configuration.md Sun Oct 04 08:14:20 2015 -0700 @@ -43,6 +43,10 @@ displayed when people visit the root URL of your wiki. Page names are case sensitive so watch out for the capitalization. +* `default_extension` (defaults to `md`): the file extension (and therefore + formatting engine) to use by default when creating a new page. The default + values is `md` for [Markdown][]. + * `templates_dir` (defaults to `Templates`): by default, the `include` statement (see the [syntax page][2]) will first look into a templates directory for a template of the given name. This is the name of that folder. @@ -66,6 +70,7 @@ [SQLAlchemy]: http://sqlalchemy.org [whoosh]: https://bitbucket.org/mchaput/whoosh/wiki/Home [elastic]: http://www.elasticsearch.org/ + [markdown]: http://daringfireball.net/projects/markdown/ ## Permissions @@ -109,3 +114,21 @@ {{readers: *,anonymous}} {%endraw%} + +## Ignored files + +The optional `ignore` section lets you define files or folders for Wikked to +ignore (_i.e._ files that are not pages, or folder that don't contain pages). + +Each item in this section should be `name = pattern`, where `name` is irrelevant, +and `pattern` is a glob-like pattern: + + [ignore] + venv = venv + temp = *~ + temp2 = *.swp + +This will ignore a `venv` folder or file at the root, or any file or folder +anywhere that ends with `~` or `.swp`. + +