KrypticKryptic Docs

Component reference

Updated

Copy patterns from this page when writing new documentation.

Alerts

Note - informational content with the Kryptic accent theme.

Warning - important cautions, breaking changes, or security considerations.

Success - confirmations and completed steps.

Buttons

Primary
Outline
SecondaryText link

Tiles (cards)

Hover the cards to see the Kryptic accent glow.

Example tile grid

Quickstart

Step-by-step guide template with code blocks and callouts.

Introduction

Landing page template with hero buttons and tile navigation.

Code blocks

Inline code and fenced blocks with syntax highlighting:

kryptic status
kryptic secrets list

dotnet add package krypticdev

Two-column layout

Left column

Use Row and Col for side-by-side content. Add sticky to Col for a pinned sidebar column on wide screens.

{
  "projectId": "proj_example",
  "defaultEnvironment": "development"
}

API-style properties

Useful for config reference and API endpoint docs.

  • Name
    projectId
    Type
    string
    Required
    required
    Enum
    Description

    Your Kryptic project identifier from the dashboard.

  • Name
    defaultEnvironment
    Type
    string
    Required
    optional
    Enum
    Description

    Environment to fetch secrets from when KRYPTIC_ENV is not set.

  • Name
    timeout
    Type
    number
    Required
    optional
    Enum
    Possible Values: >=100 and <=10000
    Description

    Daemon connection timeout in milliseconds.

Badges

CloudExperimentalBetaInfo

HTTP method tags

Used in API reference pages:

GETPOSTPUTDELETE

Headings with annotations

Headings support MDX annotations for API docs. In your .mdx file, write:

## Create a secret { tag: 'POST', label: '/v1/secrets' }

That renders a heading with an HTTP method badge - useful when you add API documentation later.