Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.71 KB

technicaldocs.md

File metadata and controls

48 lines (30 loc) · 2.71 KB
Raw

Local development

The tutorials use Middleman to create static HTML files. However there is no need to get into installing Middleman on your computer to contribute – just follow the instructions in the README.md.

Please follow the installation instructions on the Midleman web site. Windows users need to install Ruby first.

Also it is required to install the Middleman-GH-Pages gem, if you want to push your changes to a github pages branch. You can edit content and work on the files locally without this gem also.

Once you’ve cloned the repository to your computer, using the command line or a git client like Sourcetree, running the command gem install in the repository directory should set everything up for you.

Try to run middleman server from the command line and you should see the following output:

$ middleman server
== The Middleman is loading
== LiveReload is waiting for a browser to connect
== The Middleman is standing watch at http://0.0.0.0:4567
== Inspect your site configuration at http://0.0.0.0:4567/__middleman/

You can now go to the displayed URL (in this example http://0.0.0.0:4567) to see the website running in your browser. Every change you make will be reflected in the browser in an instant, due to LiveReload.

Once you’re done, press ctrl + C on your command line to quit the process.

Committing to the repository

Try to be very granular about commits to your local repository. For example a commit with the text “Changed all things in the images tutorials.” is quire vague, use something like “Fixed typo on page …”, “Headline text more clear on page …” or “Provide a better example for …” and split it into multiple commits.

Note: Some git clients like Github for Mac or Sourcetree allow to commit lines of files individually. So make your changes at once but commit them individually.

When you’re done with changes, git push them to this repository (dev branch) if you have the right to write to the repository or make a pull request.

Updating github pages

Use the rake publish command to publish your current version automatically. If you do that to a forked repository, don’t open pull requests for changes in that branch.