Pelican Quick Site Builder (pelican-qsb)

About

Script can help to build local server or push site to GitHub. Have additional sub-arguments.

Attention! Use only in your virtual environment! All "git push" actions are used with the --force flag, so all commits will be rewritten.

---

Usage

Requirements

• Pelican
• Python >= 3.6
• ghp-import

Get start

Pre-requirements:

• Install and configure Pelican - Instruction

Install script:

• From sources:

1. Clone this repository using Git to your Pelican folder

# Simple way to clone pelican-qsb
git clone --depth=1 https://github.com/dmytrohoi/pelican-qsb.git qsb && rm -rf ./qsb/.git

2. Run pelican-qsb script for the first time and configure it

# NOTE: './qsb/' it's the PATH to pelican-qsb project dir
python ./qsb/make_site.py

• From pip:

1. Install script from pip:

pip install pelican-qsb

2. Run pelican-qsb script in your Pelican directory for the first time and configure it:

pelican-qsb

Functions

github   [-d] [-b]    # make gh-output and push it to github repository
                      # (without [d]raft and [b]ackup as default)
local                 # make local server using pelicanconf.py file
backup                # backup all files in your Pelican directory to backup repository

-h, --help                # print help info

---

Created by Dmytro Hoi, 2019