Metadata-Version: 2.1
Name: workdown
Version: 0.0.3
Summary: Write Markdown and have it published and hosted on Cloudflare Workers
Home-page: https://github.com/eldridgea/workdown
Author: Eldridge Alexander
Author-email: eldridgea@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: markdown

# Workdown #

A system to write Markdown and have it published and hosted via [Cloudflare Workers](https://workers.cloudflare.com/)

## Pre-requisites ## 
* Python 3
* Install [`wrangler`](https://github.com/cloudflare/wrangler)
* virtualenv

## Usage ##
1. `git clone` this repository
2. cd into the directory
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.
4. Start a python virtualenv `python3 -m venv .env`
5. Enter the virtualenv `source .env/bin/activate`
6. Install dependences `pip install -r requirements.txt`
7. Make a markdown file ending in `.md` in the `content/` directory If you want it to be your main page, name it `index.md`.
8. Run `python workdown.py`
9. Done!

## Assets ##
Text-based assets, e.g. CSS, javascript, etc should go in the `assets/` directory. They will be available as their full filename under `assets`. For example if you make `main.css`, it will be `example.com/assets/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 `assets/` or would like to include a a fonts CDN, add it into the `<head>` in the `assets/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`.



