Mercurial > wikked

comparison README.md @ 166:a7aa5c86350e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added a short `README` file.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 12 Jan 2014 01:18:33 -0800
parents
children 9e771e0b76f5
comparison
equal deleted inserted replaced
165:3b23fe46b1a1 166:a7aa5c86350e
1
2 W I K K E D
3 ===========
4
5 Wikked is a wiki engine entirely managed with text files stored in a revision
6 control system like Mercurial or Git.
7
8 It's in early alpha, and will probably not work at all except on my machine. If
9 you still want to try it, great! Please note that:
10
11 * On Mercurial is supported at the moment. Git support is planned.
12 * The command-line interface is temporary and incomplete.
13 * Lots of incomplete or buggy stuff. Like I said it's alpha!
14 * Please report any bug on [Github][gh].
15
16
17 ## Installation
18
19 Install Wikked the usual way:
20
21 pip install wikked
22
23 Or, if you're using `easy_install`:
24
25 easy_install wikked
26
27 You can also install it from the source, which you can find on [BitBucket][bb]
28 or [Github][gh].
29
30 [bb]: https://bitbucket.org/ludovicchabant/wikked
31 [gh]: https://github.com/ludovicchabant/Wikked
32
33
34 ## Setup
35
36 Until Wikked is feature complete with its command-line utility, there's a few
37 steps needed to setup a new wiki:
38
39 1. Create a new Mercurial repository: `hg init mywiki`
40 2. Go there: `cd mywiki`
41 3. Create a `Main Page.md` text file, put some text in it.
42 4. Run `wk reset` to initialize the wiki.
43 5. Run `wk runserver` and navigate to `localhost:5000`.
44
45 If you're using an existing repository instead in step 1, make sure that you add
46 the `.wiki` folder to your `.hgignore`, and that's where Wikked will cache some
47 stuff (which you don't want committed or showing up in `hg status`).
48
49
50 ## Wiki Configuration
51
52 You can configure your wiki with a `.wikirc` file in the root of your website.
53
54 Optionally, you can define a `.wiki/wikirc` file, and any settings in there will
55 be merged with the `.wikirc`. The difference is that the one at the root is
56 typically committed to source control, whereas the one in the `.wiki` folder
57 will only be local to the current repository clone, so that makes it possible to
58 have local overrides.
59
60 The configuration is written in INI-style:
61
62 [section]
63 name = value
64 other = whatever
65
66 [other_section]
67 name = value
68
69
70 ### `wiki` Section
71
72 All the following configuration settings should be in a `[wiki]` section:
73
74 * `default_extension` (defaults to `md`): the default extension to use when
75 creating new pages.
76
77 * `main_page` (defaults to `Main Page`): the name of the page to display by
78 default in the browser.
79
80 * `templates_dir` (defaults to `Templates`): the directory to search for first
81 when including pages only by name (as opposed to by fully qualified path).
82
83
84 ### `ignore` Section
85
86 This section defines more files or folders for Wikked to ignore (_i.e._ files
87 that are not pages, or folder that don't contain pages).
88
89 Each item in this section should be `name = pattern`, where `name` is irrelevant,
90 and `pattern` is a glob-like pattern:
91
92 [ignore]
93 venv = venv
94 temp = *~
95 temp2 = *.swp
96
97 This will ignore a `venv` folder or file at the root, or any file or folder
98 anywhere that ends with `~` or `.swp`.
99
100