https://github.com/samwilson/markdownsite
A simple system to build markdown-based websites, using Pandoc.
https://github.com/samwilson/markdownsite
markdown pandoc travis-ci websites
Last synced: 3 months ago
JSON representation
A simple system to build markdown-based websites, using Pandoc.
- Host: GitHub
- URL: https://github.com/samwilson/markdownsite
- Owner: samwilson
- Created: 2017-02-05T04:34:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-01T06:21:23.000Z (about 7 years ago)
- Last Synced: 2025-02-12T18:52:45.615Z (8 months ago)
- Topics: markdown, pandoc, travis-ci, websites
- Language: Smarty
- Size: 10.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Markdownsite
===========
Markdownsite is a simple Github- and Travis-based system
for creating websites based on Markdown files.
## Getting started
1. [Create a new repository](https://github.com/new) on Github.
2. Import this repository:
`https://github.com/samwilson/markdownsite-example.git`
3. Activate your new repository on Travis,
via [your profile](https://travis-ci.org/profile/).
4. [Create a personal access token](https://github.com/settings/tokens) on Github
with the "Access public repositories" scope.
5. Add two Travis environment variables:
- the personal access token as `GH_TOKEN`
- and your email address as `GH_EMAIL`
6. Browse to `https://USERNAME.github.io/REPONAME` (with your username and repository name substituted).
Every Markdown file (with file extension `.md`) in your repository
will be built into both an HTML and PDF version.
## Pushing to a different branch than 'gh-pages'
If you're using your base user repository `USERNAME/USERNAME.github.io`
then you need to keep your source Markdown files in a branch other than
`master`, because that's where the built HTML and PDF files will be pushed.
To inform Markdownsite of this, set the `GH_BRANCH` variable in Travis (step 5 above).
## Converting an existing repository to a markdownsite
Set your .travis.yml file to contain the following:
language: bash
sudo: required
install:
- git clone https://github.com/samwilson/markdownsite.git
script:
- markdownsite/travis-deploy.sh
Then, continue from step 4 above.
## Templates
There are two templates that you can edit: `pdf.tpl` and `html.tpl`.