urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

reformat

master
Joey Hess 2007-11-16 13:22:40 -05:00
parent 6ffaa2fb04
commit 134dc894b6
1 changed files with 192 additions and 186 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/setup.mdwn
View File

@ -1,8 +1,8 @@
This tutorial will walk you through setting up a wiki with ikiwiki.
1. [[Download]] and [[install]] ikiwiki.
### 1. [[Download]] and [[install]] ikiwiki.
2. Decide where your wiki's files will go.
### 2. Decide where your wiki's files will go.
As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
and outputs the files to a destination directory. If you keep your wiki in
@ -18,7 +18,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
Note that ikiwiki owns the working copy directory; do not perform your own
edits in ikiwiki's working copy.
3. Create the beginnings of your wiki.
### 3. Create the beginnings of your wiki.
This will create a simple main page for the wiki.
@ -28,10 +28,10 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
In the editor, you could start by entering a simple page like
[[toggle id=page text="this one"]].
[[toggleable id=page text="""
Welcome to your new wiki.
All wikis are supposed to have a [[SandBox]],
All wikis are supposed to have a \[[SandBox]],
so this one does too.
----
@ -45,25 +45,29 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will
automatically get a [[SandBox]], and some other useful pages.
4. Build your wiki for the first time.
### 4. Build your wiki for the first time.
ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/
Replace the url with the real url to your wiki. You should now
be able to visit the url and see your wiki.
5. Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding
the wiki.
### 5. Add content to your wiki.
Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding the
wiki.
To quickly get started on a common task like blogging with ikiwiki, you
can copy in files from the [[examples]]. The examples are located in
`doc/examples/` in the ikiwiki source package.
You can play around with other ikiwiki parameters such as `--wikiname`
You can experiment with other ikiwiki parameters such as `--wikiname`
and `--rebuild` too. Get comfortable with its command line (see
[[usage]]).
6. By now you should be getting tired of typing in all the command line
### 6. Add a setup file.
By now you should be getting tired of typing in all the command line
options each time you change something in your wiki's setup. Time to
introduce setup files.
@ -81,7 +85,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
will set everything up.
7. Turn on additional features.
### 7. Turn on additional features.
Now you have a basic wiki with a configuration file. Time to experiment
with ikiwiki's many features.
@ -96,10 +100,10 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
`ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the
[[plugins]]..
8. Put your wiki in revision control.
### 8. Put your wiki in revision control.
At this point you might want to check your wiki in to a revision control
system you can get history of past changes and revert edits. Depending
system so you can keep track of changes and revert edits. Depending
on the revision control system you choose, the way this is done varies.
There's little that's ikiwiki specific about these instructions; this is
@ -203,7 +207,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
rm -r $SRCDIR-old
"""]]
9. Configure ikiwiki to use revision control.
### 9. Configure ikiwiki to use revision control.
Once your wiki is checked in to the revision control system,
you should configure ikiwiki to use revision control. Edit your
@ -219,5 +223,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
And in the web interface, RecentChanges should work, and files changed
by web users will also be committed using revision control.
10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]. And check out
[[tips]] to find out how to get more out of ikiwiki.
### 10. Enjoy your new wiki!
Add yourself to [[IkiWikiUsers]]. And check out
the [[tips]] to find out how to get more out of ikiwiki.