Skip to content
Convert a markdown file to a page hosted by CF Workers
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
workdown added publishing of script itself Sep 23, 2019
.gitignore
LICENSE
README.md Update README.md Sep 24, 2019
requirements.txt removed unneeded requirements Sep 21, 2019
setup.py added publishing of script itself Sep 23, 2019

README.md

Workdown

A system to write Markdown and have it published and hosted via Cloudflare Workers

Pre-requisites

Usage

  1. Run pip3 install workdown
  2. Run wrangler config and configure with your Cloudflare credentials
  3. Run wrangler generate --type="javascript" site https://github.com/eldridgea/workdown-example-site. This will generate a folder called site containing the folder structure workdown requires to work.
  4. Configure wrangler.toml with your Cloudflare details and have workers_dev = false.
  5. Make sure your route ends in a wildcard e.g. route = "https://example.com/*"
  6. Run wrangler kv:namespace create pages and wrangler kv:namespace create css and paste the bindings into your wrangler.toml.
  7. Edit content/index.md file.
  8. From the site folder (or whatever you named it) run workdown
  9. Done!

CSS

CSS should go in the css/ directory. They will be available as their full filename under css. For example if you make main.css, it will be example.com/css/main.css

Partials

Here is where you can customize the header and footer of pages in HTML. Currently all partials apply to all pages generated. Good things to do here would be if you have a static CSS file in css/ or would like to include a a fonts CDN, add it into the <head> in the partials/header.html so it will be usable on your pages.

Notes

The path for content will be the name of the markdown file with no extension. For example if you make contact.md, it will be example.com/contact.

Also, Workers only work on (sub)domains proxied by Cloudflare. So make sure you have your domain that you used in your wrangler.toml path proxied.

Install directly from Github

pip3 install git+https://github.com/eldridgea/workdown

Manual Install

  1. git clone https://github.com/eldridgea/workdown
  2. cd workdown
  3. python3 setup.py install
You can’t perform that action at this time.