このドキュメントについて

CIRCUS Design Note は Koa を使って Markdown, LESS などのドキュメントをホストするウェブサーバです。

リモートでのドキュメント閲覧

CommonMark 対応の Markdown (markdown-it) を使っているため GitHub 上でもある程度は読めますが、複数のプラグインを有効にしていろいろ整形しているため、専用サイトから読むことをお勧めします。

CIRCUS Design Note (閲覧用): http://circus-design-note.netlify.app/

GitHub にプッシュされたものが自動デプロイされます。（要 ID/password）

ローカル環境に clone したリポジトリをローカルのブラウザで読む場合は以下のようにします。

npm install
npm start

して、 http://localhost:3000/ にアクセスしてください（要 Node.js 10.x 以上）。

プロジェクトルートに .env を配置してポートの設定が可能です。（.env はデフォルトで gitignore されています）

PORT=8080

ローカルにリポジトリをクローンして普通に編集し、commit & push してください。閲覧/プレビュー用の HTTP サーバを立てたまま作業することをお勧めします。

基本的に普通の Markdown で書いてください。 my-filename.md は my-filename.html の URL で参照されます。

my-filename.less は my-filename.css の URL で参照されます。

/doc 配下のファイルの変更を監視しており、ファイルをセーブするとブラウザのリロードが自動で行われます（LiveReload などの外部拡張は不要です）。実装がどうなっているかは scripts/notifyUpdate.js と docs/index.js をご覧ください。

自動リロードはローカル環境ならうまく動作するはずですが、何らかの HTTP Proxy などが間に挟まってサーバからの出力をバッファしている場合、うまく動かないことがあります。

上記の自動リロードは /doc 配下のファイルしか監視しません。scripts 内にあるサーバスクリプト自体を書き換えながらデバッグ作業をする場合は nodemon などを併用しながら作業するとスムースです。

nodemon: https://nodemon.io/

CommoMark の記法は一通り使えます。他に markdown-it のプラグインで以下が有効になっています。他に必要なものがあれば scripts/markdown.js で追加を。

定義される用語

その説明がこちら。

定義される用語
: その説明がこちら。

GitHub emoji cheat sheet のものは使えるはずです。

ロケット 🚀 リップ 💄 きらきら ⭐️

ロケット :rocket: リップ :lipstick: きらきら :star:

キーワード的な部分をハイライト表示します。

キーワード的な部分を==ハイライト表示==します。

気を付けましょう！

::: warning
気を付けましょう！
:::