Building Your Own Wiki Knowledge Base with Wikitten

Publish: 2017-12-16 | Modify: 2017-12-16

Wikitten is an open-source Wiki knowledge management system developed using PHP. It supports Markdown syntax and does not require a database. It automatically generates a tree-like directory and is suitable for creating personal Wiki knowledge bases.

wikitten

Requirements

  • PHP >= 5.3
  • Fileinfo component support

Installation

  1. Download the source code from master.zip and extract it to the root directory of your website.
  2. Rename config.php.example to config.php and modify or comment out the content based on your needs. The configuration options are explained in the file.
  3. Wikitten requires pseudo-static support. If you are using Apache, you generally don't need to make any changes as the .htaccess pseudo-static rules are already included in the root directory. If you are using Nginx, add the following configuration to the server block and reload Nginx:
location ~* ^/static/(css|js|img|fonts)/.+.(jpg|jpeg|gif|css|png|js|ico|html|xml|txt|swf|pdf|txt|bmp|eot|svg|ttf|woff|woff2)$ {
    access_log off;
    expires max;
}
location / {
    rewrite ^(.*)$ /index.php last;
}
  1. Finally, access your domain to test the installation. If you see the screenshot below, it means the installation was successful. If there is an error, please troubleshoot according to the error message.

installation

Usage

Wikitten supports Markdown syntax, so you can simply store your Markdown files in the library directory and it will automatically generate a tree-like structure. You will see the following interface:

interface

If you haven't found a suitable Markdown tool on your local machine, you can check out the following options:

The template files for Wikitten are located in the views directory. You can modify them to add website analytics code, comments, and other personalization settings.

Wikitten does not have a database or an admin panel. Is it inconvenient to modify documents and upload them every time? Don't worry, you can use synchronization tools like Resilio Sync to automatically sync your local documents to the library directory. This way, they will be automatically updated. The interface will look like this:

sync

Wikitten supports file/folder search but does not support content search. Hopefully, the author will continue to improve and optimize this feature.

search

Summary

Wikitten is very convenient with its support for Markdown syntax, but it does not support team collaboration and is only suitable for personal use as a Wiki system. It was found that Wikitten has issues with displaying Chinese characters as garbled text in Windows environments, but this problem does not occur in Linux servers.

Comments
xiaoz

I come from China and I am a freelancer. I specialize in Linux operations, PHP, Golang, and front-end development. I have developed open-source projects such as Zdir, ImgURL, CCAA, and OneNav.

Random article