Skip to content

ni5arga/orchid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orchid

A minimalist static site generator for Markdown files written in Rust.

Features

  • Convert Markdown files to HTML
  • Minimal, clean themes
  • Table, images, mermaid support
  • Fast and lightweight
  • Simple command-line interface

Installation

cargo build --release

Usage

./target/release/orchid <input_dir> [output_dir] [theme]

Arguments

  • input_dir: Directory containing markdown files (required)
  • output_dir: Output directory for generated HTML files (default: ./output)
  • theme: Theme name - minimal or dark (default: minimal)

Examples

# Convert all markdown files in ./content to ./output with minimal theme
./target/release/orchid ./content

# Specify output directory
./target/release/orchid ./content ./dist

# Use dark theme
./target/release/orchid ./content ./output dark

Themes

  • minimal: Clean, light theme with modern typography
  • dark: Dark theme with high contrast

How It Works

  1. Scans the input directory for .md files
  2. Converts each markdown file to HTML
  3. Wraps the content in a minimal HTML template with the selected theme
  4. Extracts the title from the first # Heading or uses the filename
  5. Outputs HTML files with the same name as the markdown files

Example

Given a file content/hello.md:

# Hello World

This is a **markdown** file.

Running ./target/release/orchid ./content will generate output/hello.html.

About

Blazingly fast static site generator with table, images & mermaid diagram support written in rust

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages