This is the source code for the hnkansai.org website. It's a static site generated by Middleman and hosted on GitHub Pages.
If you want to contribute to the project, here's a guide to help you get started.
-
Install and read up on Middleman. If you are familiar with Ruby/Rails then you'll be up and running in no time. Most of the actual code is just HTML/JavaScript so there's no need for any deep Ruby knowledge.
-
Fork the repo and clone it locally. There are two branches, Source and Master. You'll want to do all of your work on the Source branch (or a new topic branch you create locally).
-
After you've cloned the repo locally, switch to the root of the project and run
$ middleman build
$ middleman
Now you should be able to view the site locally at http://localhost:4567. Going forward, you will want to make all of your changes in the /source directory. Go wild in there. Important note: If you make changes directly in the /build directory they will be overwritten when the site is built. /source is your friend. /build is bad.
- When you are happy with your changes, commit and push to GitHub.
$ git checkout source
$ git add -A
$ git commit -m "Some awesome changes to HN Kansai"
$ git push origin source
Now submit your pull request to the Source branch of this repo. Once it's been accepted, we'll rebuild the site manually to incorporate your changes. If you have any questions along the way, you can contact [email protected]
Run middleman deploy.