cortexjs.io

此存储库包含“ Cortexjs.io”网站的源文件。

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页面的主要好处是工作流程集成（在GH上进行Pobshing触发了所服务网站的自动更新）

这些网站的内容主要是作为降价文件撰写的，并以eleventy处理将其转换为HTML/CSS。

主要的eleventy配置在config/eleventy.js文件中，包括要使用的降价的定义。

Markdown引擎是markdown-it它实现了Concommark。

mardown-it-attrs插件允许段落的样式，例如

这是一个通知。 {.notice - info}

markdown-it-deflist插件支持PANDC样式定义列表：

 Term 1
:   Definition 1
:   Second definition

输出在submodules/cortex-js.github.io目录中。该目录是git子模块，链接到cortex-js.github.io repo。该存储库是GH页面发布的（对于组织，只能发布整个存储库，对于项目，其中内容可以包含在A /docs目录中）。

另请参见子模型。

cortex-js.github.io repo还必须包括两个其他文件：

• .nojekyll
• CNAME cortexjs.io内容

这些文件是在运行npm run stage时创建的。

在cortex-js.github.io repo中使用“设置”选项卡，以指示使用自定义域。

此外， cortexjs.io的DNS条目必须包括以下内容：

• 指向www.cortex-js.io指向cortex-js.io cname记录
• 四个A记录指向
  • 185.199.108.153
  • 185.199.109.153
  • 185.199.110.153
  • 185.199.111.153

内容

npm run build命令将API的文档从Typecript .d.ts文件中build/目录中的文档。

构建过程使用typedoc工具来解析API标头文件并在build/目录中输出json文件。

注意：要调试转换器，请使用VSCODE调试器。选择调试>开始调试以在VSCODE中开始调试会话。

然后， build-guides脚本将json文件转换为./src/build build目录中的降级，然后在npm run build或npm start时可以通过高架处理。

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是有效的。