@rahuldshetty/inscribe
v0.0.3
Published
A minimalist Static Site Generator (SSG) for blogs and documentation.
Downloads
57
Maintainers
Readme
Inscribe is a modern static site generator built with Bun, MDX, and Preact. It's designed to be fast, simple, and developer-friendly, making it perfect for blogs, documentation, and personal portfolios.
[!IMPORTANT] This project is currently under active development. Features and APIs are subject to change.
✨ Features
- [x] CLI – Simple commands to scaffold, develop, and build your site.
- [x] Dev Server – Local development server with instant live reload.
- [x] MDX & Markdown – Write content using powerful MDX and standard Markdown.
- [x] Themes – Customizable and extensible theme system.
- [ ] Search – Integrated full-text search.
- [ ] Plugins – Flexible plugin architecture for extending functionality.
🚀 Quick Start
Installation
# Using Bun (Recommended)
bun install -g @rahuldshetty/inscribe
# Using npm
npm install -g @rahuldshetty/inscribeUsage
Scaffold a new project, start the development server, or build for production.
# Initialize a new project in the current directory
inscribe init
# Run the development server with live reload
inscribe dev
# Build the static site for production
inscribe build🛠️ Commands
| Command | Description |
| :------------- | :-------------------------------------------------------------- |
| init | Create a new scaffold for your blog or portfolio. |
| dev [path] | Start the local development server (default: . port 3000). |
| build [path] | Generate a production-ready static website (default: ./dist). |
