Quick start guide

[zhaoda]

For the impatient, here's how to get a Spring blog site up and running.

First of all

• Fork the Spring repository as yours.
• Goto your repository settings page to rename Repository Name.
• Hosted directly on GitHub Pages from your project repository, you can take it as User or organization site or Project site(create a gh-pages branch).
• Also, you can set up a custom domain with Pages.

Secondly

• Open the index.html file to edit the config variables with yours below.

$.extend(spring.config, {
  // my blog title
  title: 'Spring',
  // my blog description
  desc: "A blog engine written by github issues [Fork me on GitHub](https://github.com/zhaoda/spring)",
  // my github username
  owner: 'zhaoda',
  // creator's username
  creator: 'zhaoda',
  // the repository name on github for writting issues
  repo: 'spring',
  // custom page
  pages: [
  ]
})

• Put your domain into the CNAME file if you have.
• Commit your change and push it.

And then

• Goto your repository settings page to turn on the Issues feature.
• Browser this repository's issues page, like this https://github.com/your-username/your-repo-name/issues?state=open.
• Click the New Issue button to just write some content as a new one blog.

Finally

• Browser this repository's GitHub Pages url, like this http://your-username.github.io/your-repo-name, you will see your Spring blog, have a test.
• And you're done!