rustic-ssg
| Crates.io | rustic-ssg |
| lib.rs | rustic-ssg |
| version | 0.0.3 |
| created_at | 2024-11-12 09:08:17.333082+00 |
| updated_at | 2024-11-29 17:03:06.415722+00 |
| description | A simple, efficient static site generator written with Rust. |
| homepage | |
| repository | https://github.com/BersisSe/Rustic |
| max_upload_size | |
| id | 1444684 |
| size | 94,490 |
Bersis Sevimli (BersisSe)
documentation
README
Rustic 🌲
Rustic is a fast and minimalistic static site generator built with Rust. Create stunning websites with simplicity, flexibility, and lightning-fast performance.
🚀 Features
- Dynamic Markdown to HTML conversion with templating support.
- Lightning-fast builds leveraging Rust's performance.
- Live preview server with hot reload.
- Customizable themes and templates.
- Simple CLI for seamless workflows.
📥 Installation
1. Install via Cargo
Ensure you have Rust installed, then run:
cargo install rustic-ssg
2. Download Prebuilt Binaries
Download prebuilt binaries from the Releases Page.
Add the binary to your system PATH to use it globally.
3. Build from Source
Clone the repository and build using Cargo:
git clone https://github.com/your-username/rustic-core.git
cd rustic-core
cargo build --release
Move the resulting binary (target/release/rustic) to a directory in your PATH.
🛠️ Usage
Commands
| Command | Description |
|---|---|
rustic init |
Initialize a new Rustic project. |
rustic build |
Generate the static site in the output/ folder. |
rustic serve |
Start a local server with hot reload. |
rustic clean |
Remove the output/ directory. |
rustic help |
Display command usage and options. |
Example Workflow
- Initialize a project:
rustic init cd my-rustic-site - Build the site:
rustic build - Preview locally:
rustic serve - Clean the build:
rustic clean
✨ Documentation
Detailed guides and examples are available in the Documentation.
🌍 Community
- Contributions are welcome! Check the Contributing Guide.
- Report bugs or suggest features via GitHub Issues.
📜 License
Rustic is open-source software, licensed under the Apache-2.0 License.