Skip to content

kujirahand/konawiki3

Repository files navigation

KonaWiki3

Goals of KonaWiki3

KonaWiki is a simple Wiki designed specifically for writing manuscripts, creating manuals, and sharing information.

The data in the Wiki is just plain text files, which allows for detailed differences to be tracked in conjunction with Git. Developers have been using KonaWiki3 as a substitute for text editors for many years. Let's accomplish great tasks using the small and simple KonaWiki.

Additionally, through the configuration options, it is possible to save in Markdown as well as KonaWiki notation. You can use your preferred notation for markup.

KonaWiki3 is simple.

It is very simple PHP wiki engine.

* header

text text text text

** header2

table:

| table | test
| aaa | bbb

list:

- item1
- item2
- item3

code:

{{{#code(js)
console.log('hello');
}}}

AI Writing Assistance Features

We are implementing AI writing assistance features. These include summarizing texts, proofreading, rephrasing sentences, and automatically continuing writing, among others. By obtaining a ChatGPT API key and specifying it in the Konawiki settings, users can access AI support functions.

How to install Konawiki3

[Use Git command]

  1. Install WebServer and PHP
  2. Download
  • git clone --recursive https://github.com/kujirahand/konawiki3.git
  • OR git clone https://github.com/kujirahand/konawiki3.git AND git submodule update --init --recursive

[Use Uploader to Hosting server]

  1. Download Konawiki3 zip file from releases
  2. Unzip
  3. chmod data, cache, private directories
  4. Access index.php

And write data/.htaccess (Apache):

# access limitation
<Files *.txt>
  Order deny,allow
  Deny from all
</Files>
<Files *.md>
  Order deny,allow
  Deny from all
</Files>

Install Library (Option)

When you want to use Git, execute shell commands.

cd kona3engine
composer install

Output PDF (Option)

    1. Access config page, and set PDF-output TRUE
    1. If Mojibake then put fonts in ./vendor/fonts(.ttf)
  • PDF output manual

Git support (Option)

You can commit and push wiki diffs to your git repository.

# set your remote repository in `/data` dir
cd data
git remote add origin git@github.com:hoge/fuga.git

And set git_enabled to true at the config.

Config page

First login by Admin User, and access config page.

[URI] index.php?go&editConf

Plugin list

[URI] index.php?FrontPage&plugin&name=pluginlist

Docker

docker-compose up