You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,29 +16,25 @@ We would like to [invite you to contribute](/docs/contribute/) to this Knowledge
16
16
17
17
## Local install of the website
18
18
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).
20
21
21
-
Install Jekyll:
22
+
Then, in the terminal, install Jekyll:
22
23
```
23
24
gem install jekyll
24
25
```
25
26
26
-
Install the website:
27
-
27
+
Clone the wp-a11y-docs repository into your preferred directory and in that directory run:
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.
39
35
40
-
Before commit use the linters: `npm run lint`
36
+
Before making a commit or pull request, run the linters with: `npm run test`.
41
37
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.
43
39
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