Miroirs/wruby
1
0
Fork 0
mirror of https://git.sr.ht/~bt/wruby synced 2024-09-28 15:21:02 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
45 commits 1 branch 0 tags 98 KiB
Ruby 74.2%
HTML 24.4%
Makefile 1.4%
Find a file
Bradley Taunt 82d4bd8ded Cleanup README, give directions for patches etc
2024-09-19 12:48:54 -04:00
pages websites: add adast.dk 2024-09-15 12:12:40 -04:00
posts Force RSS time to set itself to midday, put original post date back 2024-07-24 10:22:01 -04:00
public/images Update README, add directories, image, LICENSE, and build config 2024-07-21 12:18:17 -04:00
.gitignore Add websites page, new blog post example 2024-07-22 08:46:55 -04:00
_config.yml Pull out configuration into separate file,update homepage post count, default post index page 2024-07-23 09:36:35 -04:00
footer.html Pull out configuration into separate file,update homepage post count, default post index page 2024-07-23 09:36:35 -04:00
header.html Include proper top ID ref, add comment in root index 2024-07-23 09:55:23 -04:00
index.md Avoid confusion with the ruby gem 2024-07-23 09:58:02 -04:00
LICENSE Update README, add directories, image, LICENSE, and build config 2024-07-21 12:18:17 -04:00
Makefile Remove Gemfiles and use inline bundler instead 2024-07-26 08:53:21 -04:00
README.md Cleanup README, give directions for patches etc 2024-09-19 12:48:54 -04:00
wruby.rb Update README to avoid errors and cleanup main wruby script 2024-09-18 10:47:01 -04:00

README.md

wruby

  • Minimal blog and static site generator. The "w" is silent...
  • Licensed under MIT
  • Discussion, patches etc. go to the list

Dependencies

  • ruby (ruby-dev if needed)
  • ruby gems: kramdown and rss

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)
  • 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. wruby is based off of Ruby 3.3.3 (use rbenv or rvm to avoid privilege conflicts)
  2. Install dependencies: gem install 'kramdown:2.4.0' 'rss:0.3.0'
  3. Run make build in the root directory
  4. Upload build folder to your server
  5. Share your blog or site!