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 /content/docs./site/content/learn content/learn./site/content/guides /content/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]に連絡してください
mit
