Vellum is a minimalist Rust-powered static site generator designed to transform collections of Markdown files into beautiful, self-contained HTML documents. It's perfect for professional portfolios, technical documentation, or any project where you want a single, portable file that includes all its assets (CSS, JS, and images).
Initially built for professional portfolios with built-in support for skill matrices and achievement tracking, Vellum makes your Markdown collections transportable and readable for everyone.
- Zero-Dependency Output: Generates a single HTML file with all CSS, JS, and images inlined (Base64).
- Offline First: Works perfectly without an internet connection.
- Achievement Tracking: Highlight milestones with a simple custom syntax.
- Colored Tags: Define regex patterns to automatically style text as colored tags.
- Smart Includes: Compose large documents from multiple Markdown files effortlessly.
- Skill Matrix: Render beautiful, color-coded skill tables automatically.
- Template Customization: Fully customizable HTML templates, CSS, and JavaScript.
- Dynamic Variables: Inject dates, years, and file metadata directly into your content.
# Clone the repository
git clone https://github.com/xuedi/vellum.git
cd vellum
# Install (installs binary to ~/.local/bin and config to ~/.config/vellum)
just install
# Run with default config
vellumjust installThis command builds the release version and:
- Moves the
vellumbinary to~/.local/bin/. - Sets up
~/.config/vellum/with defaultconfig.toml,style.css,script.js, andtemplate.html.
vellumBy default, Vellum looks for a configuration at ~/.config/vellum/config.toml.
vellum --config path/to/your/config/If you are working on the Vellum source code, you can use just:
just run # Run the generator
just demo # Generate all demo files (portfolio, rockband, etc.)
just test # Run the test suite
just check # Run all quality checks (fmt, lint, test)Vellum is configured via a config.toml file.
[document]
title = "My Professional Portfolio"
dropdown = "Archives" # Optional: Header section to turn into a dropdown
[paths]
markdown = "data/index.md" # Entry point Markdown file
logo = "assets/logo.png" # Path to your logo
output = "dist/index.html" # Where the generated HTML will be saved
# Optional: Define patterns to render as colored tags
[colored_tags]
"KW\\d{2}-OK" = "green" # Matches KW01-OK, KW52-OK, etc.
"KW\\d{2}-NO" = "grey"
"KW\\d{2}-FAIL" = "red"Highlight key achievements in lists using the <! marker:
- 2024-05-20: Lead the migration to Microservices <! Achievement unlocked: Zero downtime migrationThe text after <! will be styled prominently in the output.
Define regex patterns in your config to automatically render matching text as colored pill-shaped tags:
[colored_tags]
"KW\\d{2}-OK" = "green"
"KW\\d{2}-FAIL" = "red"
"TODO" = "yellow"Then in your markdown:
**Results**: KW02-OKWill render "KW02-OK" as a green tag.
Available colors: green, grey, red, blue, yellow, orange, purple
Keep your project organized by splitting content into multiple files:
## Projects
Include: (projects.md)Vellum will automatically inline the content of projects.md at that location.
Create professional, color-coded skill tables. Vellum automatically detects tables under headings containing keywords like "skill", "matrix", "competency", or "proficiency":
## My Skills
| Technology | Rating | Description |
|----------------|--------|------------------------|
| **Languages** | | |
| Rust | 9 | Expert level |
| Python | 7 | Automation & Scripting |
| **Tools** | | |
| Docker | 8 | WIP - Optimizing CI |Column detection is flexible:
- Skill column: Skill, Skills, Name, Technology, Tool, Competency, etc.
- Value column: Level, Rating, Score, Proficiency, Experience, etc.
- Notes column (optional): Notes, Description, Comment, Details, etc.
Values (0-10) are automatically color-coded. Rows with bold skill names and empty values become category headers.
Use dynamic variables that update every time you build:
{{currentDate}}: Current date (YYYY-MM-DD){{currentYear}}: Current year (YYYY){{currentDateTime}}: Current month and year{{lastUpdate:file.md}}: Modification date of a specific file
Check out the demo files in the demo/ directory to see Vellum in action:
- portfolio.html - Professional portfolio showcasing skills and experience
- vellum.html - Documentation-style page demonstrating Vellum's features
- rockband.html - Creative example with a different visual style
Generate these demos yourself with:
just demoDistributed under the EUPL v1.2 License. See LICENSE for more information.