docs.checklyhq.com
1.0.0
$ npm install
$ npm start
$ npm run start:api$ npm run build
$ npm run deploy推到任何分支都将通过Vercel生成部署预览
推到
main将通过Vercel自动部署到生产
这是通过github动作自动完成的,请参见.github/worksflows/algolia-docsearch.yml 。
文档,学习和指南部分对贡献开放。如果您发现一个错误,或者认为可以改善某些东西,请打开PR?
./site/content/docs docs./site/content/learn content/learn./site/content/guides /Guides 您可以按以下方式制作精美的围栏代码块。我们识别任何打字稿和JavaScript代码块,并为其添加一个不错的徽标。
``` ts {title="src/index.ts"}
console . log ( ' hello world ' )
```您还可以通过在代码块中添加hl_lines属性来突出显示代码块中的某些行。
``` ts {title="src/index.ts", hl_lines=[2]}
console . log ( ' hello world ' )
console . log ( ' this will be highlighted ' )
console . log ( ' goodbey world ' )
``` 我们删除了所有自定义的雨果快艇,并用降价警报代替了。您可以使用以下类型:
[!NOTE] (默认,与未指定任何类型相同)[!WARNING][!CLI] > This is a default note / info alert.
> [ !NOTE ]
> This is the same as the default note / info alert, just more explicit.
> [ !WARNING ]
> This is a warning.
> [ !CLI ]
> This adds a CLI tip! 您是否想与您的产品共享用例并使用核对的经验?成为客座作家。通过[email protected]与我们联系
麻省理工学院