This lets you author simple stories in Markdown and embed javascript and other things that you cannot on other hosts like WordPress. Your posts will get automatically turned into HTML by the "Jekyll" engine.
- Fork this repository (you only need to do this once). This will create a copy of this repository in your GitHub account.
- Use the web UI on GitHub.com to create a new file in the
_postsfolder (follow the file naming convention you see there). - Copy the
sample-storyinto there and edit to with your story and the related embedded content. - Make sure to save ("commit") when you are done.
- Create a "pull-request" via GitHub. This will let me know that you have some new content for me to pull in.
- Checkout the sample post source code in this repository - you can see the HTML version of it too.
- Copy and paste that into a plain text file (or a Google Doc with no fonts or anything).
- Edit your plain text file to format your post in Markdown and add in any custom HTML or Javascript.
- Turn in your plain text file, or a link to it, and I will add it here so it will be automatically converted into a webpage.
This uses Jekyll to process your markdown and turn it into static HTML files. This makes it very cheap and easy to share on the web, because are no databases involved and no server code that needs to run in the cloud somewhere. That has made Jekyll very popular for cheap and easy distribution of HTML.
GitHub, now owned by Microsoft, is a major backbone of software development practices. They offer free hosting for HTML repositories via GitHub Pages, which we are using here to automatically run Jekyll to turn all the setup files and Markdown content into HTML pages (this happens automatically when new changes are made to the repository.)
To install, run this one time: bundle install.
To run the local server: ./run.sh.