Skip to content
This repository has been archived by the owner on Sep 24, 2021. It is now read-only.
/ pelican-qsb Public archive

Pelican Quick Site Builder: Simple helper to automate building site on @getpelican

License

Notifications You must be signed in to change notification settings

dmytrohoi/pelican-qsb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pelican Quick Site Builder (pelican-qsb)

made-with-python Codacy Badge License: MIT GitHub release (latest by date) GitHub Release Date PyPI

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

Get start

Pre-requirements:

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
  1. 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
  1. 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