PowerWiki ドキュメント

Git ベースのマークダウン Wiki システム。自動同期、構文ハイライト、Feishu スタイルの UI をサポート。

🔗 オンラインデモ: https://powerwiki.ga666666.cn

English • 中文 • 日本語 • 한국어 • Español • Français • Deutsch • Русский

言語選択

その他の言語のドキュメント：

特徴

自動同期 - Git リポジトリからドキュメントを自動取得・更新
コードハイライト - 複数のプログラミング言語の構文ハイライトに対応
レスポンシブデザイン - あらゆるデバイス画面に対応
自動目次 - 記事の目次を自動生成
モダンUI - シンプルで直感的なインターフェース
PDF サポート - PDF ファイルを高清に表示
アクセス統計 - 記事の閲覧数を自動統計
軽量 - データベース不要
SEO 最適化 - 検索エンジン可視性を全面的に最適化
Frontmatter サポート - YAML メタ情報を解析
ローカル画像 - Markdown でのローカル画像引用に対応
多言語 - 日本語と英語をサポート
Docker サポート - 完全な Docker デプロイをサポート

クイックスタート

前提条件

Node.js >= 14.0.0
Git

Docker を使用（推奨）

# リポジトリをクローン
git clone https://github.com/steven-ld/PowerWiki.git
cd PowerWiki

# 設定ファイルを作成
cp config.example.json config.json
# config.json を編集して Git リポジトリ URL を設定

# Docker Compose で起動
docker-compose up -d

Node.js を使用

# リポジトリをクローン
git clone https://github.com/steven-ld/PowerWiki.git
cd PowerWiki

# 依存関係をインストール
npm install

# 設定ファイルを作成
cp config.example.json config.json
# config.json を編集して Git リポジトリ URL を設定

# サーバーを起動
npm start

ブラウザで http://localhost:3150 にアクセスしてください。

設定

config.json を編集：

{
  "gitRepo": "https://github.com/your-username/your-wiki-repo.git",
  "repoBranch": "main",
  "port": 3150,
  "siteTitle": "My Wiki",
  "siteDescription": "Knowledge Base",
  "autoSyncInterval": 180000,
  "pages": {
    "home": "README.md",
    "about": "ABOUT.md"
  }
}

オプション	説明	デフォルト
`gitRepo`	Git リポジトリ URL	-
`repoBranch`	ブランチ名	`main`
`mdPath`	マークダウンファイルサブディレクトリ	`""`
`port`	サーバーポート	`3150`
`siteTitle`	サイトタイトル	`PowerWiki`
`siteDescription`	サイト説明	`Wiki`
`autoSyncInterval`	自動同期間隔（ミリ秒）	`180000`
`sortOrder`	ソート順序 (`modified` または `name`)	`modified`
`pages.home`	ホームページファイル	`""`
`pages.about`	About ページファイル	`""`

Docker デプロイ

Docker イメージ

@sayunchuan が PowerWiki の Docker イメージを提供しています。

イメージ名: sayunchuan/powerwiki
Docker Hub: sayunchuan/powerwiki
バージョンタグ: latest, 1.4.5, 20260207

クイックスタート

# 最も簡単な方法
docker run -d -p 3150:3150 sayunchuan/powerwiki

# カスタム設定を使用
docker run -d \
  --name powerwiki \
  -p 3150:3150 \
  -v $(pwd)/config.json:/app/config.json:ro \
  -v powerwiki_data:/app/data \
  -v powerwiki_cache:/app/cache \
  sayunchuan/powerwiki

Docker Compose デプロイ

version: '3.8'
services:
  powerwiki:
    image: sayunchuan/powerwiki:latest
    ports:
      - "3150:3150"
    environment:
      - NODE_ENV=production
      - LANG=ja
    volumes:
      - ./config.json:/app/config.json:ro
      - powerwiki_data:/app/data
      - powerwiki_cache:/app/cache
    restart: unless-stopped

volumes:
  powerwiki_data:
  powerwiki_cache:

# サービスを開始
docker-compose up -d

# ログを確認
docker-compose logs -f

# サービスを停止
docker-compose down

謝辞: @sayunchuan 氏に感謝します。PowerWiki の Docker イメージを提供していただき、デプロイがより便利になりました。

記事の整理

PowerWiki は記事を整理するための階層的なフォルダー構造をサポート：

your-wiki-repo/
├── README.md              # ホームページ
├── ABOUT.md               # About ページ
├── images/                # グローバル画像（オプション）
├── Architecture/          # カテゴリーフォルダー
│   ├── images/            # カテゴリー画像
│   ├── IoT-Device-Standards.md
│   ├── TLS-Encryption.md
│   └── README.md          # カテゴリーインデックス
└── Projects/              # 別のカテゴリー
    ├── images/
    ├── URL-Shortener.md
    └── README.md

記事の Frontmatter

各記事には YAML frontmatter メタデータを含めることができます：

---
title: 記事のタイトル
description: SEO 用の記事説明
author: 作者名
date: 2026-01-10
updated: 2026-01-10
keywords: キーワード1, キーワード2, キーワード3
tags: [タグ1, タグ2]
---

技術スタック

バックエンド: Express.js
フロントエンド: Vanilla JavaScript
Git: simple-git
Markdown: marked + highlight.js
PDF: pdfjs-dist
コンテナ化: Docker

プロジェクト構造

PowerWiki/
├── src/                     # ソースコード
│   ├── index.js             # Express サーバーエントリポイント
│   ├── routes/              # ルーターモジュール
│   │   ├── api.js           # API ルーター
│   │   ├── feeds.js         # RSS/Sitemap ルーター
│   │   └── static.js        # 静的ファイルルーター
│   ├── config/              # 設定モジュール
│   │   ├── env.js           # 環境変数
│   │   └── i18n.js          # 国際化
│   └── utils/               # ユーティリティモジュール
│       ├── cacheManager.js  # キャッシュ管理
│       ├── gitManager.js    # Git 操作
│       └── markdownParser.js# Markdown パーサー
├── locales/                 # 翻訳ファイル
├── templates/               # HTML テンプレート
├── public/                  # 静的アセット
│   ├── index.html          # フロントエンド HTML
│   ├── app.js             # メインエントリ（モジュラー）
│   ├── js/                # JavaScript モジュール
│   │   ├── theme.js       # テーマ管理
│   │   ├── i18n.js        # 国際化
│   │   ├── cache.js       # クライアントキャッシュ
│   │   ├── utils.js       # ユーティリティ
│   │   ├── posts.js       # 投稿リストとツリー
│   │   ├── article.js     #記事レンダリング
│   │   ├── toc.js         # 目次生成
│   │   └── media.js       # コードコピー、画像ビューア、PDF
│   └── css/               # CSS モジュール
│       ├── base.css       # ベーススタイルと変数
│       ├── layout.css     # レイアウト
│       ├── sidebar.css    # ナビゲーションメニュー
│       ├── article.css    # 記事と Markdown
│       ├── toc.css        # 右側目次バー
│       ├── media.css      # レスポンシブ対応
│       └── components.css # UI コンポーネント
├── config.example.json      # 設定テンプレート
└── package.json             # 依存関係

ライセンス

MIT License - LICENSE をご覧ください。

貢献者

@sayunchuan - 多言語、Mermaid サポート追加、さまざまな問題の修正

このプロジェクトが役に立ったら、⭐ Star を押してください！

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PowerWiki ドキュメント

言語選択

特徴

クイックスタート

前提条件

Docker を使用（推奨）

Node.js を使用

設定

Docker デプロイ

Docker イメージ

クイックスタート

Docker Compose デプロイ

記事の整理

記事の Frontmatter

技術スタック

プロジェクト構造

ライセンス

貢献者

FilesExpand file tree

README_JA.md

Latest commit

History

README_JA.md

File metadata and controls

PowerWiki ドキュメント

言語選択

特徴

クイックスタート

前提条件

Docker を使用（推奨）

Node.js を使用

設定

Docker デプロイ

Docker イメージ

クイックスタート

Docker Compose デプロイ

記事の整理

記事の Frontmatter

技術スタック

プロジェクト構造

ライセンス

貢献者