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]與我們聯繫
麻省理工學院