diff options
| author | Divay Prakash <divayprakash3@gmail.com> | 2018-11-17 19:04:43 +0530 |
|---|---|---|
| committer | Divay Prakash <divayprakash3@gmail.com> | 2018-11-17 19:04:43 +0530 |
| commit | bcd10cdd362a3996af82998f1073c44645dc4d2d (patch) | |
| tree | 47982ccbe0c9b11712289ba62b5056edf26c05d8 /CONTRIBUTING.markdown | |
| parent | 38ece14b4ff6afd8cfd7698148e0e9211ef9a514 (diff) | |
Add local build instructions, closes #3396
Diffstat (limited to 'CONTRIBUTING.markdown')
| -rw-r--r-- | CONTRIBUTING.markdown | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 455c3256..0c35c3f2 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -78,3 +78,21 @@ If you want to add yourself to contributors, keep in mind that contributors get equal billing, and the first contributor usually wrote the whole article. Please use your judgement when deciding if your contribution constitutes a substantial addition or not. + +## Building the site locally + +You can buid the site locally to test your changes. Follow the steps below. + +* Install Ruby language runtime and RubyGems. See [here](https://middlemanapp.com/basics/install/) for more details. +* Clone or zip download the [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) repo. + * `git clone https://github.com/adambard/learnxinyminutes-site` +* Install Middleman and other required dependencies using Bundler. + * `cd learnxinyminutes-site/` + * `bundle install` +* Checkout the [learnxinyminutes-docs](https://github.com/adambard/learnxinyminutes-docs) repo as `source/docs`. + * `cd source/docs/` + * `git clone https://github.com/adambard/learnxinyminutes-docs ./source/docs/` +* Build the site or run a development server to test your changes (NOTE: run +these commands at `learnxinyminutes-site/`). + * Build - `bundle exec middleman build` + * Dev server - `bundle exec middleman --force-polling --verbose` |