Skip to content

A simplistic blog engine written in Rust. Takes in markdown files as input. Outputs a static website.

Notifications You must be signed in to change notification settings

parapsychic/BlogOnIt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Blog On It

Planned Idea

  • Converts MD files into basic html files
  • Generates a table of contents as home page
  • Follows Obsidian style: file name implied for h1, others are lower level headers.

Includes bad rust habits. Don't expect me to use Rc or RefCell. I have two brain cells that do not know of each other's existence.

How to Use?

tl;dr: cargo run <folder containing markdown files> <website name>

  • Make Markdown files. Math mode and codeblocks (highlighting, parsing is supported) are not supported as of now. And by extension, none of the advanced funny stuff.
  • Organize them into folders/directories (call it whatever you want you windows/unix purists).
  • (Optional) Add an index.md with raw html. This html would be injected into the body before the list of contents in the front page (index.html).
  • List of Contents will have a descending order according to it's last modified order (hopefully).
  • Run cargo run <markdown folder> <website name>
  • Once built, you can also use the binary in target folder/directory.
  • The website will be generated in a folder/directory called website.
  • Style it yourself. All have styles.css in the <head>, if you are into that stuff.

Upload somewhere and enjoy.

Example

Example of generated files in examples folder. In my defense, I provided only the topic. ChatGPT wrote the blogs.

It Just WorksTM

Todd's Mark of Approval (not real)

About

A simplistic blog engine written in Rust. Takes in markdown files as input. Outputs a static website.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published