ABlog Quick Start¶
This short walk through of blogging work flow assumes that you have already installed ABlog. If not, see Installation guide.
Note that this post is a working draft. Feel free to revise it on GitHub.
Start a Project¶
To start a new project, run
ablog start command in a directory where you want to keep your project source files.
This command will ask you a few questions and create the following files:
conf.pythat contains project configuration for building HTML pages.
first-post.rst, a blog post example.
index.rstthat contains content for the landing page of your website.
about.rst, another non-post page example.
Build and View¶
With no further delay, let’s see what your project will look like.
ablog build, in your project folder, to have HTML pages built in
ablog serve to view them in your default web browser.
See ABlog Commands for more information about these commands.
Your landing page is built from
index.rst and contains links to your first post and about page.
Take a look at
index.rst for some tips on navigation links within the project.
Pages in your project are
.rst files that are only a
post directive short of becoming blog posts.
To make regular pages accessible from the navigation bar, you need to list them in a
This is shown for about page into
You can convert any page to a post with a
ABlog will take care of listing posts in specified archives and sidebars.
You can start new blog posts with either a front-matter or a directive using ABlog. Simply use something based on the following template as the front-matter:
:date: January 1, 2020
:author: A. Author
Simply use something based on the following template as the directive for ABlog:
.. post:: January 1, 2020
:author: A. Author
There are four major groups of configuration options that can help you customize how your website looks:
ABlog Configuration Options - add blog authors, post locations and languages to your blog, adjust archive and feed content, etc.
Options for HTML output - configure appearance of your website.
Alabaster theme options - link to your GitHub account and project, set up tracking, etc.
You might have noticed that your project contains three folders that we have not mention yet. Here they are:
_staticis for keeping image,
html_static_pathSphinx option for more information.
_templatesis for custom HTML templates. See
templates_pathfor more information.
.doctreefolder, created after build command is called, is where Sphinx stores the state of your project. Files in this folder saves time when you rebuild your project.