wruby/README.md

wruby

This is a heavy work-in-progress and I am hardly a Ruby expert. Please consider contributing to make the project better!

Minimal blog and static site generator. The "w" is silent...

Dependencies

• ruby 3.3.0

Install required gems:

bundle install

Getting Started

Make your changes in the main configuration file _config.yml file (site URL, your name, etc.). Remove the .build.yml unless you plan to host with sourcehut pages, otherwise edit this file with your own details.

• Blog posts go under the posts directory as markdown files
  • Posts need to be structured with an h1 on the first line, a space on the second, and the date on the third line (ie. 2024-07-20)
• Pages go under the pages directory as markdown files
• Media (images, videos etc) go in the root public directory

Defaults

• The homepage only displays the first 5 posts. You can configure this in _config.yml under post_count.
• The full blog post index will be generated at yoursite.com/posts
  • This means you need to have a posts.md file in your pages directory (or change posts_index the core _config.yml)

Running

1. Run make build in the root directory
2. Upload build folder to your server
3. Share your blog or site!