Freeze and thaw Markdown to HTML with Remark and (Frozen) Flask and serve via GitHub pages.
- Licensed under a three clause BSD License
- Includes some Remark sources (c) Ole Petter Bang
- Includes some Springy sources (c) Dennis Hotson
- Example project: https://github.com/scisoft/git-intro/
- Example web slides: http://scisoft.github.io/git-intro/
Create an empty repository on GitHub e.g. called "example".
Create an empty directory with the same name as the repository
("example") and in this directory copy-paste the following
to a file called talk.md:
# Title slide
## Your Name
Your affiliation
---
layout: false
## Second slide
- Hey
- Ho
- Lets
- Go
---
## Third slide
- Example equation (with MathJax): $$ a^2 + b^2 = c^2 $$
After that follow these steps:
git init
git add talk.md
echo "venv/" > .gitignore
git add .gitignore
virtualenv venv
source venv/bin/activate
pip install Flask
pip install Frozen-Flask
git submodule add https://github.com/rbast/refreeze.git refreeze
python refreeze/flask_app.py # serve via http://0.0.0.0:5000/
python refreeze/freeze.py # create static html
git add index.html # deploy html to github pages
git commit -m "initial commit"Now create a gh-pages branch and push the branch to GitHub
(adapt username and repository name):
git checkout -b gh-pages
git remote add origin git@github.com:you/example.git
git push -u origin gh-pagesFew minutes later marvel at http://you.github.io/example/. Yay!
If you want to use images,
put them under img/ and reference them like this:
The directory does not have to be called img.
The placeholder {{ base }} is replaced by freeze.py.
You can resize images like this:
<img src="{{ base }}/img/figure.gif" style="width: 400px;"/>