A little markup
[ikiwiki.git] / docs / howtos / how_to_edit_this_site / index.mdwn
1 ## Making changes
2
3 * All files can be edited by anyone.  Start with the the `/sandbox` page.
4 * Changes to the site config are generated into the site with the command `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
5 * To create new pages on the web, add a new wiki link and then follow the link.  If you cannot find a good place for the link, use the [[/sandbox]].
6 * To move a page, create a new page with the old page's content, and place '\[\[!meta redir=newpage\]\]' on the old page for a redirect.
7 * To delete a page, edit it and press the "Remove" button.
8 * This entire site is kept in a git repo, so larger changes/reversions can be done at the repo level.
9 * Add images directly to the repo in `/usr/local/www/ikiwiki-srcdir/` with git, and they will automatically be brought into the site by the post-commit hook.  
10 * Users on leaf.dragonflybsd.org in the ikiwiki group can clone from `/usr/local/www/ikiwiki-repo.git/` and edit with a favorite editor, and then push back.  You need to be in the 'ikiwiki' group.
11 * If some random person completely scrambles a page, and there's no subsequent commits, you can undo it on leaf by going to `/usr/local/www/ikiwiki-srcdir` and performing `git revert HEAD`, then rebuilding.
12 * To lock pages so that random people can't edit them, look for the 'lock' section in the ikiwiki.setup file.  Remember to regenerate.
13 * To disable users that repeatedly spam the site, add them to the banned_users list in the ikiwiki.setup file.   Remember to regenerate.
14 * Many other settings are commented into the `ikiwiki.setup` file; check there if there's a desired feature that isn't documented here. 
15
16 ### Local editing
17
18 To check out a local copy of the site, you must have an account on leaf and be part of the ikiwiki group.  
19
20 To edit on leaf, clone from `/usr/local/www/ikiwiki-repo.git/`.  
21
22 To bring it to your own machine, 
23
24     git remote add origin ssh://leaf.dragonflybsd.org/usr/local/www/ikiwiki-repo.git
25
26
27 ## Styles
28
29 * When naming a page, use underscores to indicate spaces between words in the name.
30 * Avoid CamelCase.
31 * When creating a new page, make sure to link to it somewhere else on the site.
32 * Use [Markdown](http://daringfireball.net/projects/markdown/syntax) for page syntax.
33 * Straight HTML can be used for page element if needed, though it can get messy; stick to Markdown where possible.
34
35 ## For more information
36
37 * This site contains ikiwiki documentation under /[[ikiwiki]].
38 * Markdown is documented at [daringfireball.net](http://daringfireball.net/projects/markdown/syntax).
39 * [[Formatting information|ikiwiki/formatting]] is linked at the bottom of the form when editing any page.
40 * ikiwiki is documented at the [ikiwiki site](http://ikiwiki.info/).