cortexjs.io

このレポは、「cortexjs.io」Webサイトのソースファイルが含まれています。

tl; dr

プロジェクトをクローニングした後、またはいくつかのソース変更を行った後に初めて

git submodule init

git submodule update

# Setup, make a dev build and start a server
npm start

新しいリリース後にドキュメントを更新します

 # Pick-up changes in the dependent modules
npm run update

# Generate .md files for API and launch local server
npm start

更新をステージに上げて展開します

npm run stage
# Make a clean production build.
# Output goes inside submodules/cortex-js.github.io

npm run restart
# Validate that everything works well in the browser then...

npm run deploy
# submodules/cortex-js.github.io (a git submodule) gets pushed to cortex-js.github.io

建築

このサイトは、githubページを使用して公開されています。 GHページを使用することの主な利点は、ワークフロー統合です（Pubshing to GHは、提供されているサイトの自動更新をトリガーします）

サイトのコンテンツは、主にマークダウンファイルとして作成され、HTML/CSSに変えるためにeleventyで処理されます。

メインのeleventy構成は、使用するマークダウンの定義を含むconfig/eleventy.jsファイルにあります。

Markdownエンジンはmarkdown-itです。

mardown-it-attrsプラグインを使用すると、段落のスタイリングが可能になります

これは通知です。 {.notice - info}

markdown-it-deflistプラグインは、PANDCスタイルの定義リストをサポートしています。

 Term 1
:   Definition 1
:   Second definition

出力はsubmodules/cortex-js.github.ioディレクトリにあります。そのディレクトリは、 cortex-js.github.io repoにリンクされているgitサブモジュールです。そのレポはGHページで公開されているものです（組織の場合、プロジェクトの場合、コンテンツをA /docsディレクトリに含めることができます）。

サブモジュールも参照してください。

cortex-js.github.ioリポジトリには、2つの追加ファイルも含める必要があります。

• .nojekyllは、GithubにJekyllでこのレポのコンテンツを処理してはならないことを示しています（これはすでにJekyllからの出力であるため）
• cortexjs.ioの内容を含むCNAME

これらのファイルはnpm run stageを実行するときに作成されます。

cortex-js.github.ioレポの[設定]タブを使用して、カスタムドメインの使用を示します。

さらに、 cortexjs.ioのDNSエントリには、以下を含める必要があります。

• www.cortex-js.ioをcortex-js.ioに指すcnameレコード
• 4つのレコードを指します
  • 185.199.108.153
  • 185.199.109.153
  • 185.199.110.153
  • 185.199.111.153

コンテンツ

npm run buildコマンドは、typescript .d.tsファイルからbuild/ディレクトリにAPIのドキュメントを生成します。

ビルドプロセスは、 typedocツールを使用してAPIヘッダーファイルを解析し、 build/ディレクトリにjsonファイルを出力します。

注：コンバーターをデバッグするには、VSCODEデバッガーを使用します。 [デバッグ]> [デバッグを開始]を選択して、VSCODEでデバッグセッションを開始します。

build-guidesスクリプトは、 jsonファイルを./src/buildディレクトリのMarkDownに変換し、 npm run buildまたはnpm startでEleventyごとに処理できます。

CSSスタイリング情報はsrc/_sass/で定義されています。

APIドキュメントは、Googleドキュメントスタイルガイド（https://developers.google.com/style/api-reference-comments）とhttps://developers.google.com/styleに従う必要があります。

さらに、タイプスクリプトコードは、Googleスタイルガイドhttps：//google.github.io/styleguide/jsguide.html#namingに従う必要があります。

セットアップとスクリプト

このプロジェクトは、プロジェクトスクリプトを命名するためのGitHub標準に従います。

ローカルビルドを行うには：

npm start

ステージングの準備ができているビルドを行うには：

npm run stage

テスト

生成されたサイトの「テスト」は、リンクのチェックで構成され、生成されたHTMLが有効であることがあります。