https://github.com/humansinput/etblog
Extremely tiny static blog generator written in Ruby
https://github.com/humansinput/etblog
blog gem markdown ruby static-blog-generator static-site-generator
Last synced: 16 days ago
JSON representation
Extremely tiny static blog generator written in Ruby
- Host: GitHub
- URL: https://github.com/humansinput/etblog
- Owner: humansinput
- Created: 2019-08-22T14:26:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-22T16:06:57.000Z (almost 6 years ago)
- Last Synced: 2025-05-07T09:12:03.512Z (25 days ago)
- Topics: blog, gem, markdown, ruby, static-blog-generator, static-site-generator
- Language: Ruby
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.asciidoc
Awesome Lists containing this project
README
= ETBlog (Extremely Tiny Static Blog Generator)
*ETBlog* is a yet another static blog generator written in Ruby that tries to be as lightweight as possibile.
== Installation (using RubyGems)
[source,bash]
----
$ sudo gem install etblog -N
----
That's it!
== Installation (from sources)
First, you will obviously need Ruby 2.1 or newer.
You will need to install Kramdown and plist first:
[source,bash]
----
$ sudo gem install kramdown plist -N
----
Then build and install this gem:
[source,bash]
----
$ gem build etblog.gemspec
$ sudo gem install --local ./etblog-0.1.1.gem -N
----
== Creating a blog
Basically, you need to use the `etblog` command-line utility to create and build blogs.
First, create a directory for your blog:
[source,bash]
----
$ mkdir myblog
$ cd myblog
----
Now run `etblog init` to initialize the blog:
[source,bash]
----
$ etblog init
----
After that, you should get this directory tree:
[source]
----
.
├── blog.plist
└── static
----
The `blog.plist` file is the configuration file of your blog. There, you can specify:
[squares]
- Your name and the name of your blog
- The description of your blog
- Links to various posts and sites that the user will see on the sidebar
Open it in your favorite text editor and change the name of your blog, specify your real name and change the description.
If you would like to change the folder where the compiled HTML files should be placed, change the `Static` option too.
Adding links is pretty easy. As the key, you specify the title of the link and as the value, you specify the href location of the link. Example (add this after ``):
[source,xml]
----
Tim K's website
http://timkoi.gitlab.io`.
- `@{title}` - mandatory tag. Will be substituted with the name of the blog. If you are building a Bootstrap-based theme, put it in the navbar.
- `@{description}` - optional tag. Will be substituted with the description of the blog.
- `@{links}` - optional tag. Will be substituted with the links specified in `blog.plist`. If you are building a Bootstrap-based theme, put it in the navbar.