https://github.com/ablaze-mirai/wikitool
Ablaze-MIRAI/Wikiを管理するためのCLIツール
https://github.com/ablaze-mirai/wikitool
cui golang tool
Last synced: about 1 year ago
JSON representation
Ablaze-MIRAI/Wikiを管理するためのCLIツール
- Host: GitHub
- URL: https://github.com/ablaze-mirai/wikitool
- Owner: Ablaze-MIRAI
- Created: 2022-09-01T16:33:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T19:49:06.000Z (over 1 year ago)
- Last Synced: 2025-01-29T02:48:15.095Z (over 1 year ago)
- Topics: cui, golang, tool
- Language: Go
- Homepage:
- Size: 21.5 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wikitool 🔥
**Ablaze-MIRAI/Wiki**(Ablazeの非公開な内部Wiki)を管理するためのCLIツール。
Wikiの構造に則っていれば誰でも使用できます。
## Wikiについて
Wikiとは、Githubでドキュメント管理するためのディレクトリ構造とその実装です。
```sh
.
├── README.md(現在地)
└── カテゴリ
├── README.md
└── 記事.md
```
上のように、カテゴリ名でディレクトリ名を作り、その中に`README.md`と記事を追加します。`README.md`は必須ではありませんが、wikitoolで検索した際にプレビューが表示されるので追加することを推奨します。
## 🚀 使い方
### 新規記事作成
`wikitool new`
### 記事の編集
`wikitool edit`
現在、カテゴリの追加(ディレクトリの新規作成)はwikitoolから出来ない為、新しいカテゴリが必要な場合は自身で作成して下さい。
また、Gitについても連携機能がまだ未実装なためご自身で実行してください。
## ⬇️ Install
`go install https://github.com/Ablaze-MIRAI/wikitool@latest`
## ⛏️ 開発
```sh
go mod tidy
go run main.go
go build
```
## 📝 Todo
- [ ] カテゴリーの追加機能
- [ ] 全文検索
- [ ] Git連携
## 📜 ライセンス
MIT
### 🧩 Modules
- promptui
- go-fuzzzyfinder
- cli
## 👏 影響を受けたプロジェクト
GaaTS(Github as a Text Storage)
## 💕 スペシャルサンクス
[Modules](#🧩-modules)