Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.93 KB

README.md

File metadata and controls

57 lines (38 loc) · 2.93 KB
Raw

Intro

This is a kickstarter project landing page template made by Mu-An using Jekyll.
It is pain-free to set up even if you are not tech-savvy, here's a live demo: http://muan.co/kickstarter, and here's some of the basics about this project just so you have an idea:

  1. The template is built using Jekyll, but there's no need to worry if you don't know what it is
  2. Everything can be personalised in the file called _config.yml
  3. You should be able to set up absolutely everything without leaving GitHub
  4. The page is hosted using GitHub pages, and it is soooo easy
  5. The url will look something like this: http://[your_username].github.io/, and you can use a custom domain if you have one.

Inspired by Soma's landing page project, originally made for Stair Rover and now for everyone.

Instruction

  1. You will need to have a GitHub account.
  2. After you're logged in, fork this repository (Feel free to ignore the terminology and just click the link)
  3. You will now have a clone under your account, go to https://github.com/[your_username]/kickstarter/settings and change your repository name to [your_username].github.io. Make sure you replace [your_username] with your username! Otherwise you will get a 404 error.
  4. Finally, personalise the project page by going to https://github.com/[your_username]/[your_username].github.io/edit/master/_config.yml and edit the Kickstarter specific settings.
    After you're done, just click on Commit Changes.
  5. You should be all set to go now, how nice! Go to http://[your_username].github.io/ to see if it works!

If you know your way around code

Here's a list of things that could be easily modified:

  1. CSS styles:
    The styles are written in SCSS, rake command is available for you to autocompile css files and run jekyll.

  2. Themes:
    Currently there is only one theme, the basic one. Feel free to develop your own in the theme folder and/or send a pull request in, but remember to make all information generic and easy to set using only the config file.

  3. More stuff
    As mentioned, the whole thing is built on Jekyll, so just explore Jekyll and you'll find wonders.

  4. Adding more pages
    It is as easy as adding a file. Say you'd like a update page, just create a update-june.md using markdown or update-june.html using html with content like:

---
layout: default
---

June Update:

Hello everyone!

And you will be able to see the page through /update-june. How nice!

Contact

Twitter, Blog, Email