Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kujirahand/konawiki3
Wiki clone
https://github.com/kujirahand/konawiki3
wiki
Last synced: about 1 month ago
JSON representation
Wiki clone
- Host: GitHub
- URL: https://github.com/kujirahand/konawiki3
- Owner: kujirahand
- License: mit
- Created: 2015-10-09T07:20:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T05:54:05.000Z (3 months ago)
- Last Synced: 2024-10-25T05:02:21.070Z (3 months ago)
- Topics: wiki
- Language: PHP
- Homepage: https://kujirahand.com/konawiki3/
- Size: 845 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 43
-
Metadata Files:
- Readme: README-ja.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Konawiki3 (日本語マニュアル)
- KonaWiki3 is Wiki clone.
- [URL] http://kujirahand.com/konawiki3/
## Konawiki3の目標
KonaWikiは原稿の執筆やマニュアルの作成、情報の共有に特化したシンプルなWikiです。
Wikiのデータはただのテキストファイルなので、Gitと連携して詳細な差分を取ることもできます。
開発者は何年もテキストエディタの代わりにKonaWiki3を使用しています。
小さくシンプルなKonawikiを使って大きな仕事を成し遂げましょう。
なお、設定オプションで、KonaWiki記法だけでなく、Markdownで保存することも可能です。
好きな記法を利用してマークアップできます。
## 日本語Wiki記法をサポートしています
日本語Wiki記法をサポートしています。
```
■大見出し
text text text text
●中見出し
text text text text
▲小見出し
text text text text
リスト
・item1
・item2
・item3
```
## PukiWikiに似た記法を採用
とてもシンプルなPukiWikiっぽいWiki記法もサポート！
```
* header
text text text text
** header2
table:
| table | test
| aaa | bbb
list:
- item1
- item2
- item3
code:
{{{#code(js)
console.log('hello');
}}}
```
## 記法はKonawikiとMarkdownを切り替えて使える！
オプションで、Markdownに切り替えもできるので、好きな記法で書けるのがKonaWikiの良いところです！
## AIによる執筆サポート機能を実装
AIによる執筆サポート機能を実装しています。テキストの要約や文章校正、文章の言い換え、続きの自動執筆など、AIによる執筆支援を利用できます。
[ChatGPTのAPIキー](https://platform.openai.com/api-keys)を取得して、Konawikiの設定画面に指定するだけで、AI支援機能を利用できます。
# Konawiki3のインストールの仕方
Gitコマンドが使えるなら、コマンド一発で設置が可能ですし、
[releases](https://github.com/kujirahand/konawiki3/releases)からZIPでダウンロードしてFTPSなどでアップロードして動かすこともできます。
詳しくは、[こちら](https://kujirahand.com/konawiki3/index.php?install)を参照してください。
### Gitを使う方法
1. ApacheなどのWebサーバーとPHPをインストール
2. 以下のコマンドを実行
- `git clone https://github.com/kujirahand/konawiki3.git`
### Gitを使わない方法:
1. [KonaWiki3のreleaseからZIPをダウンロード](https://github.com/kujirahand/konawiki3/releases)
2. 以下のようにパーミッションを変更
```sh
chmod 766 data
chmod 766 cache
chmod 766 private
```
## (オプション) Git保存機能を使う場合
Git保存機能を使う時は、composerを使ってインストールしてください。
```sh
cd kona3engine
composer install
```
ただし、レンタルサーバーによっては、うまく動かないことがあるので、その場合は、SSHからコミットしてください。
ローカルでは正しく動くものの、ロリポップなどでは動かなかったので、CRONで定期的にコミットするようにしています。
```sh
cd konawiki_path
git pull
git add ./data
git commit -a
git push
```
## (オプション) PDF機能
- 設定画面で PDF 出力をtrueに設定
- 文字化けするときは、/vendor/fonts に拡張子が.ttfのフォントを配置してください。
- 詳しくは[こちら](https://kujirahand.com/konawiki3/index.php?PDF%E5%87%BA%E5%8A%9B%E6%A9%9F%E8%83%BD)
## Gitと連携する場合
下記のようにして、dataディレクトリをGitの管理下に置くと便利かも。
```sh
# set your remote repository in `/data` dir
cd data
git remote add origin [email protected]:hoge/fuga.git
```
そして、設定画面で git_enabled をTRUEに設定してください。
## 設定ページ
最初に、管理ユーザーを設定したら、その後、設定ページにアクセスできます。
```
[URI] index.php?go&editConf
```
## Plugin list
```
[URI] index.php?FrontPage&plugin&name=pluginlist
```
## Dockerを使う場合
ターミナルから以下のコマンドを実行すると起動します。PHPのローカルサーバーの機能を利用してKonawiki3を実行します。
```
docker-compose up
```
## セキュリティアップデートのお知らせ (2021/02/22)
Konawiki v3.2.3 より前のバージョンをご利用の方は最新版にアップデートしてください。
> JVNVU#99880454 / JVN#48194211 / CVE-2020-5670