Skip to content

onetimesecret/docs.onetimesecret.com

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,009 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Onetime Secret Documentation Site

This is the documentation site for Onetime Secret, a secure way to share sensitive information that's automatically destroyed after it's read.

Built with Starlight

Features

  • Full documentation for Onetime Secret
  • Multilingual support
  • Custom components for card layouts
  • Responsive design

Setup

Make sure to install the dependencies:

# From the project root
pnpm install

Development Server

Start the development server:

# From the project root
SHOW_STAGING_WARNING=true pnpm dev

This will start Astro's development server, and you can view the site at http://localhost:4321.

Building for Production

Build the application for production:

# From the project root
pnpm build

The built files will be in the dist directory.

Project Structure

docs/                     # Project root
├── src/                  # Source directory
│   ├── assets/           # Assets including images
│   ├── components/       # Astro components
│   │   ├── CardGrid.astro        # Grid layout for cards
│   │   ├── FeatureCard.astro     # Card components
│   │   └── starlight/            # Starlight component customizations
│   ├── content/          # Documentation content
│   │   ├── docs/         # All documentation
│   │   │   ├── en/       # English content
│   │   │   └── de_AT/    # German content
│   │   └── i18n/         # Translation files
│   └── styles/           # CSS styles
├── astro.config.mjs      # Astro/Starlight configuration
├── markdoc.config.mjs    # Markdoc component configuration
└── public/               # Static files

Contributing

Contributions to documentation are welcome. Please follow these steps:

  1. Fork the repository
  2. Create a new branch
  3. Make your changes
  4. Submit a pull request

Writing a new page

Every page on this site is one of four types — Concept / Decision guide, How-to, Reference, or Architecture note. Start a new doc by copying a template, not from a blank file. See docs/templates/ for the templates and guidance on picking the right type.

One question to ask before you open a PR: does your change introduce a decision axis — a new flag, plan tier, entitlement, region, or config choice? If so, a Concept / Decision guide should reason about that choice, not just a how-to that configures it. The pull request template prompts for this.

License

This documentation site is licensed under the MIT License.

About

Home of the official Onetime Secret documentation

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Contributors