Mercurial > wikked

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