Tissevert/hablo
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
A minimalist blog generator
70 commits 10 branches 7 tags 888 KiB
Haskell 78.1%
JavaScript 16.2%
Scheme 3.1%
HTML 2.6%
Find a file
Tissevert 3cda3fb5ae Document the changes in template variables
2020-05-08 15:37:27 +02:00
doc Document the changes in template variables 2020-05-08 15:37:27 +02:00
share Fix navigation bug due to missing trailing slash in URLs causing RSS links to point to the main one even in tagged page 2020-05-07 16:57:46 +02:00
src Notice this has been generalized just above and use the generalization 2020-05-07 22:52:06 +02:00
.gitignore Initial draft 2019-01-27 21:43:19 +01:00
CHANGELOG.md Fix Open Graph cards by adding a new option to provide the site's URL 2019-12-21 12:50:38 +01:00
hablo.cabal Implement safe templating for «local» variables used during hablo rendering of the blog — not in client code 2020-05-06 10:17:33 +02:00
hablo.svg Add a logo for the project 2019-02-19 21:58:21 +01:00
LICENSE Initial draft 2019-01-27 21:43:19 +01:00
README.md Release v1.0.0 2019-04-20 09:54:21 +02:00
Setup.hs Initial draft 2019-01-27 21:43:19 +01:00

README.md

Hablo

Hablo is a minimalist tool written to generate a simple blog structure from markdown articles.

Its key principles are to keep your blog a collection of markdown files while being completely static, leveraging the fediverse to handle comments. The best image you can have of a hablo blog is a HTML/JS article viewer. Despite this heavy usage of JS, it strives to provide a clean site that can still be displayed if JS is disabled and used to get links to the markdown files themselves.

Getting started

Installation

Hablo is written in haskell and uses cabal for installation. The following instructions assume your version of cabal is fairly recent (≥ 1.24) please adapt them if you're running an older version of it, for instance on a Debian Jessie (the same command without the new- prefix roughly work but you might want to use sandboxes — read about it).

Simple install with cabal

Just issue the following line in a terminal

cabal new-install hablo

Alternatively, if you prefer to do things yourself you can do a

Manual install from this repository

Get a copy of this repository

git clone https://git.marvid.fr/Tissevert/hablo.git

Build the binary

cabal new-update
cabal new-build

Install the result

cabal new-install hablo

Using hablo (tutorials)

Wanna give it a try ? Start by generating your blog

Want to see your blog in a web browser ? How about reading a bit about deployment to get your local environment ready or setup a publicly available one ?

A bit of stretching (how-to)

Got the basics ? Wondering how to turn the dummy blog project you've created into a magnificent blog ? You should read about customization.

Exploring things in depth

If you know everything you need to start your blog and use hablo, here are some full references to help you when you need a precise description of how some option works or what metadata you can include in your articles.

References

Explanation

If you want a more general view of the project to understand its background and the logic behind the way the various options work, read about the architectural choices