Code Monkey home page Code Monkey logo

skim's Introduction

Skim

Skim is a one-page boilerplate for publishing content on GitHub. It's designed specifically for hosting on GitHub using GitHub Pages and serving up locally using Jekyll. Take a peek at the demo below and see how simple it is to roll your own site without having to use fancy code.

Skim on GitHub

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 first.

License

Code and documentation is licensed under the MIT license.

skim's People

Contributors

caleorourke avatar

Watchers

James Cloos avatar Yan Kaganovsky avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.