Deploy a dir of md files as a static site
Project description
Bloggen
Point bloggen to a hosting location, give it your markdown, then watch it deploy a static site.
Use
A parable:
Lee creates a GCP credentials json:
- Lee gets a service token JSON from GCP. He follows this guide https://cloud.google.com/storage/docs/reference/libraries#setting_up_authentication'
- Lee saves the JSON to his machine and remembers the path for later. Bloggen is going to save the path to that JSON into an environment variable
- Lee will need to tell Bloggen the path to the json by configuring a Bloggen profile
Lee configures a profile:
-
Lee runs
bloggen --config
and supplies the following information:- Name
- Path to GCP credentials json
- Name of GCP bucket to use
-
Lee writes 5 md notes into a dir
-
Lee runs
bloggen --generate path_to_md_dir
-
Lee sees a new dir appear. It is named static-site and can be found at ../path_to_md_dir
-
Lee runs
bloggen --publish path_to_static_site
-
Lee learns that his notes are available as a static site on GCP
Generate
generates static webpage User provides a directory of markdown to be converted to html
bloggen generate --path=path_to_dir
Sync
Sync directory of markdown files with existing static site
bloggen sync --path=path_to_dir_of_md_files
Add
Add file to static site
Convert given markdown file to html and add to site
bloggen add --path=path_to_md_file
Remove
Remove named page from static site
bloggen remove --name=name_of_file
Destroy
Destroy site and bucket
bloggen destroy
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.