doc: Add a modeline to ikiwiki.setup
[noc.git] / doc / ikiwiki.setup
1 # -*- mode: yaml -*-
2 # IkiWiki::Setup::Yaml - YAML formatted setup file
3 #
4 # Setup file for ikiwiki.
5 #
6 # Passing this to ikiwiki --setup will make ikiwiki generate
7 # wrappers and build the wiki.
8 #
9 # Remember to re-run ikiwiki --setup any time you edit this file.
10 #
11 # name of the wiki
12 wikiname: Realraum NOC -- documentation
13 # contact email for wiki
14 adminemail: noc@realraum.at
15 # where the source of the wiki is located
16 srcdir: .
17 # where to build the wiki
18 destdir: dest/
19
20 # base url to the wiki; keep empty for local builds (with relpaths)
21 url: ''
22 # url to the ikiwiki.cgi; keep empty for disabling
23 cgiurl: ''
24 # Do not autopush
25 gitorigin_branch: ''
26
27 # rcs backend to use
28 rcs: git
29 # plugins to add to the default configuration
30 add_plugins:
31 - html
32 - img
33 - map
34 - pagetemplate
35 - sidebar
36
37 # plugins to disable
38 disable_plugins:
39 - htmlscrubber
40
41 # additional directory to search for template files
42 templatedir: /usr/share/ikiwiki/templates
43
44 # base wiki source location
45 underlaydir: /var/empty
46
47 # use '!'-prefixed preprocessor directives?
48 prefix_directives: '1'
49
50 # use page/index.mdwn source files
51 indexpages: '0'
52
53 # generate HTML5?
54 html5: '1'
55
56 # extension to use for html files
57 htmlext: html
58
59 # strftime format string to display date
60 timeformat: '%c'
61
62 # UTF-8 locale to use
63 locale: en_US.UTF-8
64
65 # how many backlinks to show before hiding excess (0 to show all)
66 numbacklinks: '10'
67
68 # attempt to hardlink source files? (optimisation for large files)
69 hardlink: '0'
70
71 # Do not do foo/index.html
72 usedirs: '0'
73
74 # Do not try to compile dest/
75 exclude: ^dest