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