info/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2025-08-19 04:52:13 +02:00
Code Issues Releases Wiki Activity

Merge pull request #3397 from divayprakash/update-readme

Browse Source 
Add local build instructions, closes #3396
This commit is contained in:
Divay Prakash
2018-11-18 00:45:05 +05:30
committed by GitHub
parent f5b3d1c97c 9a3c737c42
commit 57ffb5b34d
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.markdown
View File

@@ -78,3 +78,26 @@ 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`
* Get the source in place
* Copy the contents of your clone of the fork of learnxinyminutes-docs repo
into the `source/docs` folder. There shouldn't be a `learnxinyminutes-docs`
folder inside the `docs` folder, it should just contain all the repo
contents.
* Checkout your fork of the learnxinyminutes-docs repo as `source/docs`.
* `cd source/docs/`
* `git clone https://github.com/YOUR-USERNAME/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`