https://github.com/paulohrpinheiro/gerablog
Blog Generator - my own static site generator
https://github.com/paulohrpinheiro/gerablog
ruby rubygem static-site-generator
Last synced: about 1 year ago
JSON representation
Blog Generator - my own static site generator
- Host: GitHub
- URL: https://github.com/paulohrpinheiro/gerablog
- Owner: paulohrpinheiro
- License: mit
- Created: 2016-12-26T23:26:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-16T09:40:36.000Z (over 2 years ago)
- Last Synced: 2025-03-17T06:11:30.846Z (about 1 year ago)
- Topics: ruby, rubygem, static-site-generator
- Language: Ruby
- Size: 485 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GeraBlog
[](https://badge.fury.io/rb/gerablog)
[](https://codeclimate.com/github/paulohrpinheiro/gerablog)
[](https://codeclimate.com/github/paulohrpinheiro/gerablog)
[](https://codeclimate.com/github/paulohrpinheiro/gerablog)
*Blog Generator - my own static site generator*
Write in *Markdown*, publish in *HTML*.
*Image created by https://robohash.org/*
## Rules
* The texts must be written in markdown.
* The first line of file will be the post title `#` mark.
* The second line is a blank line.
* The third line will be the description of text, with `##` mark. Will be in meta description of generated html.
* The filename **MUST** begin with a date: `2016-12-31-this-is-a-post.md`.
* The texts must be in a subdirectory of `texts`. Each subdirectory will be assigned a *category*.
* Change the layout by changing files in `templates` dir, which uses [Tenjin](http://www.kuwata-lab.com/tenjin/rbtenjin-users-guide.html) as template system.
* `JS` and` CSS` files put in `assets/{css, js}`.
* The images used in the posts should be placed in a `images` subdirectory, within the category directory:` texts/ruby/images/pinkpanter.jpg`. In the post, put the reference as ``.
* Images used in posts **MUST** be placed in the same level`CATEGORY/images`.
* By default, *GeraBlog* uses [prism](http://prismjs.com/) to highlight the syntax of the codes. The language indicated will be the category in which the text is. For example, the file `ruby/2016-12-31-ruby-rocks.md` if it has some source code, it will be marked as *lang-ruby*.
## Sample text:
# This is the title
## This is the description
Here the text.
Show-me the code:
puts 'Hello world!'
## Install
gem install gerablog
## Hacking
* clone the repo;
* `bundle install`;
* make changes (with tests!)
* run all the tests (`rake`) and fix anything that appears wrong
* run `rubocop` and fix all *offenses*!
* send me a PR.
## Using
The executable `gerablog` has this options:
### `-h` or `--help`
Yes, we have a `--help` option:
➤ gerablog --help
Usage: optparse [options]
-h, --help Display this screen
-n, --new FILENAME Create a new project.
-g, --generate FILENAME Generate the static blog.
### `-n` or `--new`
Create a new project:
➤ gerablog --new /tmp/test
How the project looks like?
➤ tree /tmp/test
/tmp/test
├── assets
│ └── assets
│ ├── css
│ │ ├── gerablog.css
│ │ └── prism.css
│ └── js
│ └── prism.js
├── gerablog.conf
├── output
├── templates
│ └── templates
│ ├── categories.rbhtml
│ ├── category.rbhtml
│ ├── feed.rbxml
│ ├── footer.rbhtml
│ ├── header.rbhtml
│ ├── index.rbhtml
│ └── post.rbhtml
└── texts
If `--root` is not informed, root will be `./`.
### `-g` or `--generate`
### Deploy
For my [blog](https://paulohrpinheiro.xyz):
➤ gerablog --generate ~/Dropbox/projetos/paulohrpinheiro.xyz/blog/gerablog.conf
ruby
diversos
programadorbipolar
javascript
c
perl
rust
python
Copy `output` directory to your server :)
## History
This project started with a script I made to generate my site https://paulohrpinheiro.xyz.
The script is in this gist:
https://gist.github.com/paulohrpinheiro/20130e06355fc5bffe5865ce903dce63