https://github.com/caleorourke/skim
One-page boilerplate for publishing Markdown content on GitHub.
https://github.com/caleorourke/skim
Last synced: over 1 year ago
JSON representation
One-page boilerplate for publishing Markdown content on GitHub.
- Host: GitHub
- URL: https://github.com/caleorourke/skim
- Owner: caleorourke
- License: mit
- Created: 2014-08-13T04:54:49.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2016-05-01T03:42:01.000Z (about 10 years ago)
- Last Synced: 2025-01-29T05:26:30.564Z (over 1 year ago)
- Language: CSS
- Homepage: http://caleorourke.github.io/skim
- Size: 111 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Skim
Skim is a one-page boilerplate for publishing content on GitHub. It's designed specifically for hosting on GitHub using [GitHub Pages](http://pages.github.com) and serving up locally using [Jekyll](http://jekyllrb.com). Take a peek at the demo below and see how simple it is to roll your own site without having to use fancy code.
## Quick Install
1. Clone from GitHub and go into the directory (~3 seconds). Directory size hovers around ~35 KB.
$ git clone -o master https://github.com/caleorourke/skim.git
$ cd skim
2. Install Bundler (~5 seconds).
$ gem install bundler
3. Install runtime dependencies (~15 seconds).
$ bundle install
## Roll Your Own
1. Make a fresh clone and go into the directory.
$ git clone https://github.com/username/milk.git
$ cd milk
2. Create a new `gh-pages` branch.
$ git checkout --orphan gh-pages
3. Copy the contents from /skim to /milk.
$ cp -r ~/skim/* ~/milk
4. Push your site to GitHub.
$ git add .
$ git commit -a -m "first commit"
$ git push origin gh-pages
## Contributing
Anyone is welcome to submit an issue or request. All we ask is that you glance through our [contributing guidelines](CONTRIBUTING.md) first.
## License
Code and documentation is licensed under the MIT license.