Uinelj / tibl

tiny static blog engine for use with gitoub
https://ujj.space/tibl
MIT License
0 stars 0 forks source link
blog blog-engine github-pages javascript static

tibl

tibl is a bad blog "engine" that currently consists on poorly defined js functions that get markdown posts from Github and renders them client-side.

tibl is very minimal: even the post listing is in markdown, and is done by hand. In the near future tibl may get a cli tool to manage the post listing more programmatically.

toc generation may be implemented soontm

  1. Installation
    • Github Pages
    • Web server
  2. Usage
    • Add topics/posts
  3. Files
  4. Customisation
    • Themes
    • Nav/Footer
  5. Conclusion

Installation

Since tibl is very minimal, it doesn't require anything else than something which is able to serve html.

Github Pages

  1. Fork this repository
  2. Enable Github Pages
  3. Go to your Github Pages URL

On a classic web server

TODO

Usage

Currently using tibl may appear a bit cumbersome. I'd like to provide some client editor, using client-side Github oauth login plus a tiny markdown editor someday, but I don't know if it's possible.

TLDR: t.html?t=sth renders data/topics/sth.md, t.html?p=sth renders data/topics/_sth.md, t.html alone renders database.md.

Adding topics/posts

I call them topic because why not but eh

Customization

Themes

Just use classless themes.

Note: I just tested Sakura.

nav/footer

I use a markdown nav and footer but if it's not ok for you use html.

Just change data/{nav, foot}.md to your convinience.

Conclusion

Just use something else