Skip to content

Commit d21ca60

Browse files
authored
Merge pull request #27 from wpaccessibility/13-update-readme-for-local-install-info
Update README for info local install
2 parents 6473e46 + 59ed7ec commit d21ca60

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,25 @@ We would like to [invite you to contribute](/docs/contribute/) to this Knowledge
1616

1717
## Local install of the website
1818

19-
Please read the [Guide and requirements for Jekyll](https://jekyllrb.com/docs/installation/#requirements) first. You will need to have NPM, Ruby, Ruby Gems, GCC and Make installed.
19+
WPaccessibility.org is written in [Jekyll](https://jekyllrb.com), a static site generator in Ruby using [markdown](https://www.markdownguide.org/) for content.
20+
Please read the [Guide and requirements for Jekyll](https://jekyllrb.com/docs/installation/#requirements).
2021

21-
Install Jekyll:
22+
Then, in the terminal, install Jekyll:
2223
```
2324
gem install jekyll
2425
```
2526

26-
Install the website:
27-
27+
Clone the wp-a11y-docs repository into your preferred directory and in that directory run:
2828
```
29-
git clone git@github.com:wpaccessibility/wp-a11y-docs.git
30-
cd wp-a11y-docs
3129
npm install
3230
bundle
3331
bundle exec jekyll serve
3432
```
3533

36-
Open http://127.0.0.1:4000/ in your favourite browser.
37-
38-
All Knowledge Base files live in the /docs/ directory.
34+
Open `http://127.0.0.1:4000/` or `http://localhost:4000` in your favourite browser.
3935

40-
Before commit use the linters: `npm run lint`
36+
Before making a commit or pull request, run the linters with: `npm run test`.
4137

42-
If you made changed to the `_config.yml` file, run `bundle exec jekyll serve` again to apply the changes to the site.
38+
If you made changes to the `_config.yml` file, run `bundle exec jekyll serve` again to apply the changes to the site.
4339

44-
Documentation about Jekyll itself is on [jekyllrb.com](https://jekyllrb.com/docs/). The theme is based on the Jekyll theme [Just the docs](https://just-the-docs.github.io/just-the-docs/). The changes made in Just the Docs are documented in the [Changelog for Release v0.1](/CHANGELOG/release-v01).
40+
Documentation about Jekyll itself is on [jekyllrb.com](https://jekyllrb.com/docs/). The theme is based on the Jekyll theme [Just the Docs](https://just-the-docs.com/). The changes made in Just the Docs are documented in the [Changelog for Release v0.1](/CHANGELOG/#release-v01).

0 commit comments

Comments
 (0)