docs.checklyhq.com
1.0.0
$ npm install
$ npm start
$ npm run start:api$ npm run build
$ npm run deployWenn Sie auf eine Zweigstelle drängen
Push to
mainwird automatisch über Vercel zur Produktion bereitgestellt
Dies geschieht automatisch über eine GitHub-Aktion, siehe .github/worksflows/algolia-docsearch.yml .
Abschnitte von Docs, Learn & Guides sind offen für Beiträge. Wenn Sie einen Fehler finden oder denken, dass etwas verbessert werden könnte, öffnen Sie bitte eine PR?
./site/content/docs./site/content/learn./site/content/guides Sie können wie folgt ausgefallene umzäunte Codeblöcke erstellen. Wir erkennen alle Typen- und JavaScript -Codeblöcke und fügen ihnen ein schönes Logo hinzu.
``` ts {title="src/index.ts"}
console . log ( ' hello world ' )
``` Sie können auch bestimmte Zeilen im Codeblock hervorheben, indem Sie dem Codeblock ein hl_lines -Attribut hinzufügen.
``` ts {title="src/index.ts", hl_lines=[2]}
console . log ( ' hello world ' )
console . log ( ' this will be highlighted ' )
console . log ( ' goodbey world ' )
``` Wir haben alle benutzerdefinierten Hugo -Shortcodes entfernt und sie durch Markdown -Warnungen ersetzt. Sie können die folgenden Typen verwenden:
[!NOTE] (Standard, wie keine Angabe eines Typs)[!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! Möchten Sie Ihren Anwendungsfall und Ihre Erfahrung mit der Checkly mit Ihrem Produkt teilen? Werden Sie Gastautor. Erreichen Sie uns unter [email protected]
MIT
