Mercurial > wikked

comparison README.md @ 384:93a2f7c86059

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