Ikiwiki: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
== | == About == | ||
Ikiwiki is a very lightweight wiki compiler that generates static html from markdown files through a git repository. | Ikiwiki is a very lightweight wiki compiler that generates static html from markdown files through a git repository. | ||
It is a very cool project with terrible documentation, so let's compile what we know and learn in this page! | It is a very cool project with terrible documentation, so let's compile what we know and learn in this page! | ||
== | == Installing on Debian == | ||
<blockquote>'''NOTE:''' | <blockquote>'''NOTE:''' | ||
| Line 13: | Line 13: | ||
make sure you also have <code>librpc-xml-perl</code> and <code>python-docutils</code> | make sure you also have <code>librpc-xml-perl</code> and <code>python-docutils</code> | ||
=== | === Setup <ref>https://ikiwiki.info/setup/#index1h2</ref> === | ||
You run the following command: | You run the following command: | ||
<code>ikiwiki --setup /etc/ikiwiki/auto.setup</code> | <code>ikiwiki --setup /etc/ikiwiki/auto.setup</code> | ||
| Line 36: | Line 36: | ||
<big>and your <code>$destdir</code> is <code>/home/'''<u>$USER</u>'''/public_html/'''<u>$WIKI</u>'''</code></big> | <big>and your <code>$destdir</code> is <code>/home/'''<u>$USER</u>'''/public_html/'''<u>$WIKI</u>'''</code></big> | ||
== | == Publishing your ikiwiki with nginx == | ||
heh | heh | ||
| Line 46: | Line 46: | ||
== editing the wiki == | == editing the wiki == | ||
=== adding content === | |||
=== customizing CSS === | === customizing CSS === | ||
| Line 51: | Line 53: | ||
that way you can fully customize your wiki! | that way you can fully customize your wiki! | ||
== projects built on ikiwiki == | == projects built on ikiwiki == | ||
Revision as of 19:06, 30 April 2026
About
Ikiwiki is a very lightweight wiki compiler that generates static html from markdown files through a git repository.
It is a very cool project with terrible documentation, so let's compile what we know and learn in this page!
Installing on Debian
NOTE:
where $WIKI put the name of your wiki
where $USER put the name of the local user
sudo apt install ikiwiki
make sure you also have librpc-xml-perl and python-docutils
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.
try adding 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:
You can later change these settings in /home/$USER/$WIKI.setup
Variables
Two important variables in the ikiwiki universe are $srcdir, the source directory, and $destdir, the destination directory.
You make changes in $srcdir only! Ikiwiki does the rest.
by default, your $srcdir is /home/$USER/$WIKI/
and your $destdir is /home/$USER/public_html/$WIKI
Publishing your ikiwiki with nginx
heh
Ikiwiki on a subdomain
heh
installing ikiwiki on a phone server
Claudio pls add here <3
editing the wiki
adding content
customizing CSS
add local.css in the git folder /home/$USER/$WIKI/
that way you can fully customize your wiki!