Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 1.73 KB

README.md

File metadata and controls

87 lines (55 loc) · 1.73 KB
Raw

Kunai

cpprefjp と boostjp のフロントエンド、強化版

  • cpprefjp
  • boostjp （対応予定）

ビルド

git submodule update --init
npm install
npm run build

開発

npm install
npm run dev

http://localhost:8080/

デバッグ

情報ログを有効にする

js/kunai.jsで、ErrorLoggerの代わりにDefaultLoggerを使用する

//this.log = new DefaultLogger()
this.log = new ErrorLogger()

↓

this.log = new DefaultLogger()
//this.log = new ErrorLogger()

設計思想

  • C++のことを調べて知って試すフローをcpprefjp上で完結可能にする
  • JavaScriptが無効になっていてもコンテンツ自体は閲覧可能

コンポーネント

Kunai (core)

  • cpprefjp/site のソースコードとメタ情報の包括管理
  • 読み込まれていない状態では従来と同じ機能性
  • C++バッジ
  • クイックジャンプ (crsearch)
  • サイドバー

Indexer

  • 特徴語の索引機能
  • タグクラウド

Yata

  • Playground (サンプルコードをその場で実行する機能）
  • cpprefjp/site のソースのサンプルコードの段階で C++ の #include が足りていないものを検知して自動で追加

ドキュメント

メンテナ

ライセンス

→ LICENSE