Overview

pythonicGardening is a set of tools built to allow a user to create and publish content to their Quartz repository. It was designed to incorporate CI/CD concepts into a users workflow with Quartz.

It is used in GeorgeOnTheWeb to allow me to create and push journal entries and quick notes directly to my digital garden without leaving the terminal.

Why use the terminal when other tools are available?

Because the terminal is a distraction-free environment. You can jot down your note and have it online in under 2 minutes.

Features

pythonicGardening will allow you to:

• Create a MarkDown file from template
  • Move created template to content folder, assumes you are using Quartz
• Edit a MarkDown file
  • Both from template and as a new file
• Push created files to your GitHub repository

Getting started

Star by either cloning, forking or downloading a ZIP of the files.

Depdendencies

You may need to install the following packages:

• git
• mdutils

Configuring PythonicGardening

Open config.py and adjust the following variables:

• PATH_OF_GIT_REPO
  • Set this to the path for the local repo you are going to push updates from
• COMMIT_MESSAGE
  • Set this to the default commit message you'd like to use when git_Push is executed
• contentDir
  • Set this to the director where the MarkDown files that will be published are stored
    • Quartz users, default will be .../<repo>/content/notes/
• template
  • Set this to the location for the default MarkDown template you'll be using

Adjust the template.md file to match your needs.

Roadmap

Committed

• Allow user to create custom frontmatter templates to format content
• Update title in frontmatter based on user input
• Allow users to customize config.py for:
  • Content directory (contentDir) to place created MarkDown files
  • Git commit message (COMMIT_MESSAGE) to change standard commit verbiage
  • Git repo path (PATH_OF_GIT_REPO) to change local repo targed for push

Uncomitted

• Graphical interface
  • Ruins the "all in terminal" value, would be an optional feature
• Image upload
• Fork Quartz repo to a new personal digital garden

Requests

Feature requests will be added here.

Interested in contributing?

You can contact me @georgeontheweb_ or just fork this repo.