Crates.io | orion-ssg |
lib.rs | orion-ssg |
version | 1.1.6 |
source | src |
created_at | 2022-10-31 11:22:11.506292 |
updated_at | 2024-07-02 18:04:47.249427 |
description | A static site generator to create a simple blog from Markdown files. |
homepage | |
repository | https://github.com/adriantombu/orion |
max_upload_size | |
id | 702148 |
size | 128,352 |
A static site generator written in Rust to create a simple blog from Markdown files.
orion init --path my-blog
: create a directory to start a new Orion blog (with a few fake posts)orion post --slug my-amazing-title --draft
: create a new Markdown postorion build
: export the Markdown to htmlorion serve
: build, start a local server to test your build, and watch for changes on /posts
, /static
and /themes
orion --version
: display the current version of Orionorion --help
: print the help.
├── posts
├── build.sh
├── config.toml
├── public
├── static
└── themes
/posts
Contains all the markdown files for your posts
build.sh
A build script to use in CI/CD environments
config.toml
The configuration of your site
/public
The build directory (the files that will be deployed into production)
/static
All the assets you want to use (images for your posts, for example)
/themes
It contains the different themes you can use, each folder representing them with its own assets: html layout, css,
images, ...
You can use the following values in your posts. They will be located at the top of the file in between ---
.
---
title: My great title
description: This is a small summary of my post
published_at: 2022-11-01 11:12:13
image: https://www.publicdomainpictures.net/pictures/220000/velka/orion-nebula.jpg
---
The actual markdown content
The favicon was made by Denis Moskowitz from the Noun Project.