Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Write Markdown and have it published and hosted on Cloudflare Workers

Project description

Workdown

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

Pre-requisites

Usage

  1. pip3 install workdown
  2. Run wrangler generate site https://github.com/eldridgea/workdown-example-site. This will generate a folder called site containing the folder structure workdown requires to work.
  3. Configure wrangler.toml with your Cloudflare details, make sure your route ends in a wildcard e.g. route = "https://example.com/*".
  4. Create a KV Namespace and bind in to pages in your wrangler.toml file.
  5. Make a markdown file ending in .md in the content/ directory If you want it to be your main page, name it index.md.
  6. From the site folder (or whatever you named it) run workdown
  7. Done!

CSS

CSS should go in the assets/ 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.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for workdown, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size workdown-0.0.4-py3-none-any.whl (3.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size workdown-0.0.4.tar.gz (2.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page