Note about adding images directly with git
[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
11 ## Styles
12
13 * When naming a page, use underscores to indicate spaces between words in the name.
14 * Avoid CamelCase.
15 * When creating a new page, make sure to link to it somewhere else on the site.
16 * Use [Markdown](http://daringfireball.net/projects/markdown/syntax) for page syntax.
17 * Straight HTML can be used for page element if needed, though it can get messy; stick to Markdown where possible.
18
19 ## For more information
20
21 * This site contains ikiwiki documentation under /[[ikiwiki]].
22 * Markdown is documented at [daringfireball.net](http://daringfireball.net/projects/markdown/syntax).
23 * [[Formatting information|ikiwiki/formatting]] is linked at the bottom of the form when editing any page.
24 * ikiwiki is documented at the [ikiwiki site](http://ikiwiki.info/).