How to Edit This Wiki

This wiki is an ikiwiki instance. Files are checked into git for backend storage, using git to clone the repository and then committing and pushing files.

The Crypt Code Club wiki is a project hosted on Codeberg. Anyone may send patches to update the information on the wiki. Trusted active editors to this wiki will be given commit access to the repository.

Format and style

The pages are written in Ikiwiki Markdown format, for details see formatting.

The files use the .mdwn extension.

First, the wiki configuration needs to be generated(feel free to customise it!): https://ikiwiki.info/setup/

It's highly recommended to use these plugins in addition to the ones enabled by default:

• headinganchors
• license
• link_local (useful if CGI is disabled)

The name of the wiki should be 'cryptcodeclub', unless you want to pick a different name for it.

Ikiwiki will have generated a brand new wiki, but it will be replaced with this project's wiki.

You'll need to delete the generated 'cryptcodeclub' folder first, using a file manager like File Explorer.

Further instructions below involve running commands in a command prompt (command-line shell):

# If you don't want to use a file manager, the 'rm' command will delete it instead.
# Always be careful when deleting files!
rm -rf cryptcodeclub

By running the commands below, this project's wiki will be downloaded:

git clone https://codeberg.org/cryptcodeclub/website-source cryptcodeclub

# Enter the cryptcodeclub directory
cd cryptcodeclub

The wiki can be built from scratch using the following command:

make all

How to make changes

In the local cloned sandbox make whatever changes you want to make. Add them, then commit them. For example, editing this file would be this sequence:

$EDITOR CONTRIBUTING.mdwn
git add CONTRIBUTING.mdwn
git commit

The changes can be previewed by running the following command and browsing the local wiki(at the destdir) using a web browser:

make

As a guideline, commits should be clean following the ChangeLog format (see Change Logs in GNU Coding Standards). You can check the commit history for examples.

The most recent commit can be formatted as a patch like so:

git format-patch HEAD~1

Patches can be emailed to the wiki's maintainer: adamfaiz@banting.km.edu.my

See also ikiwiki.