mirror of
https://git.sr.ht/~bt/wruby
synced 2024-09-28 15:21:02 +02:00
No description
pages | ||
posts | ||
public/images | ||
.gitignore | ||
_config.yml | ||
footer.html | ||
header.html | ||
index.md | ||
LICENSE | ||
Makefile | ||
README.md | ||
wruby.rb |
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
(ruby-dev
if needed)kramdown
gemrss
gem
Getting Started
Make your changes in the main configuration file _config.yml
file (site URL, your name,
etc.).
- 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)
- Posts need to be structured with an
- 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
underpost_count
. - The full blog post index will be generated at
yoursite.com/posts
- This means you need to have a
posts.md
file in yourpages
directory (or changeposts_index
the core_config.yml
)
- This means you need to have a
Running
wruby
is based off of Ruby 3.3.3 (userbenv
orrvm
to avoid privilege conflicts)- Install dependencies:
gem install 'kramdown:2.4.0' 'rss:0.3.0'
- Run
make build
in the root directory - Upload
build
folder to your server - Share your blog or site!