https://github.com/queirozfcom/jekyll-utils

Couple of scripts to automate common jekyll tasks
https://github.com/queirozfcom/jekyll-utils

jekyll

Last synced: 14 days ago
JSON representation

Couple of scripts to automate common jekyll tasks

• Host: GitHub
• URL: https://github.com/queirozfcom/jekyll-utils
• Owner: queirozfcom
• License: mit
• Created: 2016-01-09T23:49:00.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-06-19T05:20:48.000Z (over 1 year ago)
• Last Synced: 2024-10-28T16:59:21.797Z (2 months ago)
• Topics: jekyll
• Language: Python
• Size: 29.3 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
jekyll-utils

=======

**TODO:** 

  - Add this to PyPa (tutorial here: [Package a Python Project and make it available on PyPa](https://queirozf.com/entries/package-a-python-project-and-make-it-available-via-pip-install-simple-example))

  - Add tests for public functions 

A small Python 3 command-line application (based upon [click](http://click.pocoo.org/6/)) to speed up some common tasks for those who blog using Jekyll.

This will be **especially** useful for people who post many short blog entries, as opposed to those who prefer to blog less frequently, with longer posts.

## Installation

- Prerequisites: `virtualenv`

  - On Ubuntu, install it via `$ sudo apt-get install python3-virtualenv`

- Installing jekyll-utils from Github using pip

  - `$ git clone https://github.com/queirozfcom/jekyll-utils`

  - `$ cd jekyll-utils`

  - `$ virtualenv -p python3 jekyll-venv`

  - `$ source jekyll-venv/bin/activate`

  - `$ pip install .`

 This will install all commands to your virtualenv. Type `jk-` and then hit `` to see all available commands.

  ![jekyll-utils-commands](https://i.imgur.com/f1sF6Iq.gif)

- Initial configs. These are needed to start using the tools:

 - `$ jk-config-set-editor `

 - `$ jk-config-set-posts-path `

## Features

> TODO

## Examples

- `$ jk-new "My new Post" --tag foo --tag bar --category general --edit`

- `$ jk-edit a couple of keywords`