Ikiwiki: Difference between revisions

Revision as of 18:25, 30 April 2026

About

ikiwiki edit flow

what is ikiwiki?

Installation

NOTE:
where $WIKI put the name of your wiki
where $USER put the name of the local user

sudo apt install ikiwiki

Setup ^[1]

You run the following command:

ikiwiki --setup /etc/ikiwiki/auto.setup

If you get this error:

/etc/ikiwiki/auto.setup: Only one Term::ReadLine::Gnu instance is allowed. at /usr/share/perl5/IkiWiki/Setup/Automator.pm line 17.

then add PERL_RL=Perl before ikiwiki ^[2]

you will then get a series of prompts:

What will the wiki be named? $WIKI
What revision control system to use? git
What wiki user (or openid) will be admin? $USER
Choose a password:

once you fill them in, you're almost set!

Editing the wiki

customizing CSS

add local.css in the git folder /home/USER/IKIWIKI/

use this as your ikiwikis css file

Making your ikiwiki public with nginx

Markdown syntax

Projects running ikiwiki

References

[1] ttps://ikiwiki.info/setup/#index1h2

[2] ttps://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1113969

[1]

[2]

@@ Line 4: / Line 4: @@
 == Installation ==
+<blockquote>'''NOTE:'''
+where '''<u>$WIKI</u>''' put the name of your wiki
+where '''<u>$USER</u>''' put the name of the local user</blockquote>
   sudo apt install ikiwiki
-== Setup <ref>https://ikiwiki.info/setup/#index1h2</ref> ==
+=== Setup <ref>https://ikiwiki.info/setup/#index1h2</ref> ===
 You run the following command:
   <code>ikiwiki --setup /etc/ikiwiki/auto.setup</code>
 If you get this error:
   /etc/ikiwiki/auto.setup: Only one Term::ReadLine::Gnu instance is allowed. at /usr/share/perl5/IkiWiki/Setup/Automator.pm line 17.
-then add <code>PERL_RL=Perl</code> before ikiwiki <ref>https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1113969</ref>
+then add <code>PERL_RL=Perl</code> before ikiwiki <ref>https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1113969</ref><blockquote>you will then get a series of prompts:</blockquote>
+ What will the wiki be named? '''<u>$WIKI</u>'''
+ What revision control system to use? git
+ What wiki user (or openid) will be admin? <u>'''$USER'''</u>
+ Choose a password:
+once you fill them in, you're almost set!
 == Editing the wiki ==
-=== local.css / template ===
+=== customizing CSS ===
-after you make changes to your ikiwiki template or local.css, you should run
+add local.css in the git folder /home/USER/IKIWIKI/
-<code>ikiwiki --setup WIKINAME.setup</code>
-otherwise your changes will get overwritten every time you refresh or rebuild your wiki
+use this as your ikiwikis css file
 == Making your ikiwiki public with nginx ==