markpub setup notes
2024-12-16, 2024-12-20: FIRST REQUIREMENTS:
- Python3 installed
markpubinstall if using system python3 install:
pip install --upgrade pip
pip install markpub
- TODO:
markpubinstall if using a local Python virtual environment
NOTE: these steps assume that only one directory of Markdown documents is being set up.
TODO: create steps to install markpub to initialize several separate document collections
-
after creating directory and some markdown docs
-
set that directory up as an Obsidian vault
-
NEXT STEPS:
- initialize the directory with
markpub- this requires a
Python3installation - Apple computers have a default installation
- Microsoft Windows: Python3 can be installed from Microsoft Store
- Most Linux systems have a default installation
- this requires a
-
- install
markpubin the system wide Python environment, or a specific environment
- install
- make it a GitHub repo
- this is a collection of steps using
git:
- this is a collection of steps using
- initialize the directory with
git init
git add .
git commit -m "initial commit"
git branch -M main
git remote add origin https://github.com/band/repository-name.git
git status
git push -u origin main
- once the GitHub repository is established, initialize that repository with
markpub:
markpub init directory-name