iskm/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2025-04-26 15:13:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: edit contributing, how to build (#5163)
Some checks failed
Trigger site build / deploy (push) Has been cancelled
Details
CI / lint (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Maciej Kasprzyk 2024-10-30 21:47:12 +01:00 committed by GitHub
parent d19c7b0a00
commit a7068ea636
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.markdown
View File

@ -90,26 +90,26 @@ addition or not.
## Building the site locally ## Building the site locally
Install Ruby, on macOS you can do it by installing [Homebrew](https://brew.sh/) then Install Ruby. On macOS this can be done with [Homebrew](https://brew.sh/).
```sh ```sh
brew install ruby brew install ruby
# Install Ruby package manager
gem install bundler
``` ```
then Then clone two repos, install dependencies and run.
```sh ```sh
# Install Ruby bundler # Clone website
gem install bundler
# Clone the repo for the website
git clone https://github.com/adambard/learnxinyminutes-site git clone https://github.com/adambard/learnxinyminutes-site
# and clone the repo with all the content (this repo) into it # Clone docs (this repo) nested in website
git clone https://github.com/<YOUR-USERNAME>/learnxinyminutes-docs ./learnxinyminutes-site/source/docs/ git clone https://github.com/<YOUR-USERNAME>/learnxinyminutes-docs ./learnxinyminutes-site/source/docs/
# Install the dependencies and run the site # Install dependencies
cd learnxinyminutes-site cd learnxinyminutes-site
bundle install bundle install
# Run
bundle exec middleman serve bundle exec middleman serve
``` ```