>_ DevTrendsja

言語

ホーム

言語

セクション

フロントエンド バックエンド モバイル DevOps AI / ML ゲーム開発 ブロックチェーン 組み込み セキュリティ
Go

Wikiの設定に浪费时间するのは终わらせよう — ドキュメント作成に集中する方法

よくある话です。チーム或个人でナレッジベースが必要になり、Wiki.jsやOutline、あるいは最悪の場合Confluence开けます。そして1时间後には、PostgreSQLやRedis、S3ストレージ、300行のDocker Composeファイルの设定に足を踏み入れている。そんな时期には、简単にアイデアをメモしたいという气持ちなんてとうに消えてなくなります。

最近、LeafWikiを見つけました。このプロジェクトの著者は明らかに同じ痛苦を共有しています。"ダウンロードして実行"という原则で动作する、简素なセルフホスト型Wikiです。重い依存关系はなく、Goバイナリ1つとデータ用フォルダだけで动作します。

内部构造

LeafWikiは车轮の再发明をしようとはしていません。バックエンドにGo、インターフェースにReact、メタデータにSQLiteという、3つの简单な要素基に构筑されています。最も素晴らしいのは、実際のページコンテンツがディスク上のMarkdownファイルとして保存されるということです。

つまり、サーバーが突然クラッシュしたり、別のツールに移行决意しても、データが专用データベース内に闭じ込められてカボチャになることはありません。任意のテキストエディタ、さらにはObsidianで開くことができます。

LeafWiki

実践面で優れている点

"简单"を标榜しながら实际上は本格的な管理が必要なツールを目にすることがよくあります。LeafWikiはその点、より正直です。

ツリー构造で混沌を回避

最近の多くのノート取りツールは、タグを使った"フラット"なリスト导向です。ここでは古典的なツリー构造が手に入ります。阶層は自分で定义でき、さらにはセクション内で页を手动でソートすることもできます。これは、読顺が重要なオンボーディング资料や手続き书类にとって重要です。

作业の妨げにならないエディタ

ライブプレビュー付きのビルトインMarkdownエディタが搭载されています。テーブル、タスクリスト、脚注、さらにはMermaid图表とKaTeX数式をサポートしています。内部リンクの自动补完もあり、他のページの名前を入力し始めると、Wikiが自動的に正しいリンクを挿入します。

スマートリンク

システムはバックリンクを追迹します。各页で、その页を参照しているものを确认できます。页の名前変更や移动を行うと、LeafWikiは他のドキュメント内のリンクを自动更新できます(この机能はフラグで有効にする必要があります --enable-link-refactor)。

心配性のためのバックアップ

データフォルダを单纯にコピーする他に、最近のバージョンでは实验的なGitバックアップサポートが追加されました。Wikiはスケジュールに従ってリモートリポジトリに自动的にプッシュします。

こんな人には向いていない

先に明确にしておきますが、これはNotionの代替品ではありません。同僚のカーソルが見えるようなリアルタイム协動編集や、复雑な发布承认ワークフローはありません。10人が同時に同じ段落を編集する必要があるなら、探し続けてください。

また、LeafWikiはまだツリーの個々のブランチ単位での细かなアクセス制御には未対応です。役割(admin、editor、reader)は存在しますが、Wiki全体に适用されます。

始め方

Dockerがインストール되어 있으면、立ち上げるまで约30秒です。

docker run -p 8080:8080 \
    -v ~/leafwiki-data:/app/data \
    ghcr.io/perber/leafwiki:latest \
    --jwt-secret=super-secret-key \
    --admin-password=your-password \
    --allow-insecure=true

ローカルでHTTPSなしでプロジェクトを実行する場合は、--allow-insecure=trueフラグが必要です。Nginxや他のプロキシ経由で外部に公开する場合は、このフラグを削除することをお勧めします。

ところで、ミニマリスト向きに、LeafWikiをシステムサービスとして登録するLinux用の готовый インストーラーが用意されています:

sudo /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/perber/leafwiki/main/install.sh)"

モバイルデバイスでの作业

インターフェースはレスポンシブです。手机からテキストを編集するのは怎么说也是个作业ですが、ドキュメントを移动中に読んだり、误字をすばやく修正するのは十分に可能です。

LeafWikiがもたらすのは、予测可能性です。こんな用途に最適です:

  • 个人の技術日记やナレッジベース。
  • 小规模プロジェクト向けドキュメント。
  • 管理者やDevOpsエンジニア向けの内部ランブック。

重いWikiエンジンと格闘することに疲れ、ただ整洁に整理されるMarkdownを書きたいだけなら、このプロジェクトを試してみてください。GitHubでのスターはまだ千个未満ですが、あなたが探し求めていた"あの简单なツール"になる可能性は十分あります。

関連プロジェクト