yabi allows you to create a simple and customizable blog site with minimal effort.
Write your posts in markdown, build the blog site, and deploy it anywhere you like.
The easiest way to install from PyPI is to the pip command
pip install --user yabi
or if you have cloned the repo and want to install it directly from the source code
pip install --user <path to the repo>
Say, you want to create a new blog that describes your philosophical thoughts. You want to call it Discourses. Start by typing on a terminal
yabi init Discourses
This will create the following folder and files
Discourses
├── config.json
├── data
└── posts
To publish your first thought, create a new file on the posts folder, e.g., posts/my_first_thought.md. The only requirements for a post
is that
- It is somewhere inside the
postsfolder - Has set the label
draftto "yes" or "no" at the file header. - It has a level 1 Markdown heading with the title of the post right after the label(s).
Apart from these minimal requirements, the post can have any valid Markdown syntax.
draft: no
# My first thought
I will drink more water. I will exercise more and I will wake up earlier.
No, I'm not. I rather not to.
Finally, navigate to the base directory Discourses and build the website using the command
yabi build
All the contents of the website are generated inside a folder named public. You can upload these files to any hosting service of your
liking. If
you wish to check how the site will look before you deploy it you can use the command
yabi test
which will create a local server with your website that you can visit on the url http://localhost:9090
- Simply and minimalistic user interface
- Sane defaults for the website. Have a nice blog with all the expected features: archive, categories, and a home page with the latest posts
- Markdown-format post system. No need of complex databases, the only thing needed to build your website are the markdown files containing your posts. Ideal for version control!
- Optimized build system. Only builds what you have recently added/changed.
This software is licensed under the BSD-2-Clause License terms.
The default blog style and design was heavily based on Armin Ronacher's blog.