# YABI: Yet Another Blogging (tool) Implementation
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.
<!-- TOC -->
* [Installation](#installation)
* [Getting started](#getting-started)
* [Features](#features)
<!-- TOC -->
## Installation
The easiest way to install from PyPI is to the `pip` command
pip install --user yabi
If you have cloned the source code you can install it with
pip install --user .
## Getting started
Say, you want to create a new blog that describes your philosophical thoughts. You call it *Discourses*. To create this new blog type in a
terminal
yabi init Discourses
now navigate to the newly created folder
cd Discourses
To publish your first though, create a new file on, e.g., `posts/my_first_thought.md`. The only requirements for a post is that
1. It is somewhere inside the `posts` folder
2. Has set the label `draft` to "yes" or "no" at the file header.
3. 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, build the website using the command
yabi build
All the contents of the website are built under the folder `public`. You can upload these files to any hosting service of your liking. If
you wish to check how the site will look you can use the command
yabi test
which will create a local server with your website on `http://localhost:9090` by default.
## Features
* _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.
Raw data
{
"_id": null,
"home_page": "https://github.com/menganha/yabi",
"name": "yabi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "blog,web",
"author": "menganha",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/cd/0f/efcec75bb8911e82ed776917e7a3ba560d463c5dd74881c8a6dcd9120d5c/yabi-1.0.tar.gz",
"platform": null,
"description": "# YABI: Yet Another Blogging (tool) Implementation\n\nyabi allows you to create a simple and customizable blog site with minimal effort.\n\nWrite your posts in markdown, build the blog site, and deploy it anywhere you like.\n\n<!-- TOC -->\n* [Installation](#installation)\n* [Getting started](#getting-started)\n* [Features](#features)\n<!-- TOC -->\n\n## Installation\n\nThe easiest way to install from PyPI is to the `pip` command\n\n pip install --user yabi\n\nIf you have cloned the source code you can install it with\n\n pip install --user .\n\n## Getting started\n\nSay, you want to create a new blog that describes your philosophical thoughts. You call it *Discourses*. To create this new blog type in a\nterminal\n\n yabi init Discourses\n\nnow navigate to the newly created folder\n\n cd Discourses\n\nTo publish your first though, create a new file on, e.g., `posts/my_first_thought.md`. The only requirements for a post is that\n\n1. It is somewhere inside the `posts` folder\n2. Has set the label `draft` to \"yes\" or \"no\" at the file header.\n3. It has a level 1 Markdown heading with the title of the post right after the label(s).\n\nApart from these minimal requirements, the post can have any valid Markdown syntax.\n\n draft: no\n \n # My first thought\n\n I will drink more water. I will exercise more and I will wake up earlier.\n\n No, I'm not. I rather not to.\n\nFinally, build the website using the command\n\n yabi build\n\nAll the contents of the website are built under the folder `public`. You can upload these files to any hosting service of your liking. If\nyou wish to check how the site will look you can use the command\n\n yabi test\n\nwhich will create a local server with your website on `http://localhost:9090` by default.\n\n## Features\n\n* _Simply and minimalistic user interface_\n* _Sane defaults for the website._ Have a nice blog with all the expected features: archive, categories, and a home page with the latest\n posts\n* _Markdown-format post system._ No need of complex databases, the only thing needed to build your website are the markdown files\n containing your posts. Ideal for version control!\n* _Optimized build system._ Only builds what you have recently added/changed.\n\n",
"bugtrack_url": null,
"license": "BSD 2-Clause License",
"summary": "A static blog generator",
"version": "1.0",
"split_keywords": [
"blog",
"web"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "7929836b31adb4ee7b510d13542231c1",
"sha256": "1ed923322f1dc6fed0630fd4c938e5914c2766cbcdc4cca1ad663fc492d49e64"
},
"downloads": -1,
"filename": "yabi-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7929836b31adb4ee7b510d13542231c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13475,
"upload_time": "2022-12-12T21:47:41",
"upload_time_iso_8601": "2022-12-12T21:47:41.998433Z",
"url": "https://files.pythonhosted.org/packages/6c/7b/0db5a12a12c0d897a206746533c176bbcc4be71687410b2b528ffcb3d90a/yabi-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "495f8eb8729334c67fb3762977c09494",
"sha256": "8a905cef39ca7db889351f8ad998a28c67f227d83ad794b094f34edc357bbeb8"
},
"downloads": -1,
"filename": "yabi-1.0.tar.gz",
"has_sig": false,
"md5_digest": "495f8eb8729334c67fb3762977c09494",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 12122,
"upload_time": "2022-12-12T21:47:44",
"upload_time_iso_8601": "2022-12-12T21:47:44.241996Z",
"url": "https://files.pythonhosted.org/packages/cd/0f/efcec75bb8911e82ed776917e7a3ba560d463c5dd74881c8a6dcd9120d5c/yabi-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-12 21:47:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "menganha",
"github_project": "yabi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "markdown",
"specs": []
},
{
"name": "jinja2",
"specs": []
}
],
"lcname": "yabi"
}
JSON
