From bcd10cdd362a3996af82998f1073c44645dc4d2d Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Sat, 17 Nov 2018 19:04:43 +0530 Subject: Add local build instructions, closes #3396 --- CONTRIBUTING.markdown | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'CONTRIBUTING.markdown') 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` -- cgit v1.2.3 From 195e46d15f9e91cc8f7e8b8ad457ac02c86c6b98 Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Sun, 18 Nov 2018 00:32:47 +0530 Subject: Update local site building instructions --- CONTRIBUTING.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 0c35c3f2..e2b849bd 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -89,9 +89,14 @@ You can buid the site locally to test your changes. Follow the steps below. * 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/` +* 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` -- cgit v1.2.3 From 9a3c737c42d2ca861ccb7ae6159301bcf284ee32 Mon Sep 17 00:00:00 2001 From: Divay Prakash Date: Sun, 18 Nov 2018 00:39:46 +0530 Subject: Highlighting fix --- CONTRIBUTING.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.markdown') diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index e2b849bd..e2192d88 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -91,7 +91,7 @@ You can buid the site locally to test your changes. Follow the steps below. * `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 + 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`. -- cgit v1.2.3