Skip to content

Commit c9f627e

Browse files
sjaksSami Jakonen
authored and
Sami Jakonen
committed
Update development instructions
Add section for running the site locally and update the instructions for adding a new page Closes: #44 Closes: #69
1 parent 331ac4d commit c9f627e

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

README.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,34 @@ The repository uses Jekyll to generate HTML of the Markdown text files.
66

77
## Adding pages
88

9-
You can add new pages using included `bin/jekyll-page`
9+
You can add a new page by creating a new Markdown file inside of some of the collection directories under the `pages/` directory.
1010

11-
For example add SSH page to get started
12-
```bash
13-
ruby bin/jekyll-page "Configure SSH" get-started
11+
The new page file should start with a header that includes the following information:
1412
```
13+
---
14+
layout: page
15+
title: "My new help article"
16+
order: 1
17+
summary: "Description for my new help article"
18+
---
19+
20+
Actual content...
21+
```
22+
23+
Write the article following the Markdown syntax. You may want to refer to a [syntax guide](https://guides.github.com/features/mastering-markdown/).
24+
25+
## Running locally
1526

16-
## Building the pages
27+
You may want to preview your changes while writing an article or developing the site. You can run this Jekyll site locally if you have [Bundler and Jekyll installed](https://jekyllrb.com/docs/installation/).
28+
29+
Install the gems and start the local server:
30+
```
31+
docs$ bundle config set path 'vendor/bundle'
32+
docs$ bundle install
33+
docs$ bundle exec jekyll serve
34+
```
1735

18-
TODO
36+
The site is now accessible from http://127.0.0.1:4000/docs/.
1937

2038
## Publishing the pages
2139

0 commit comments

Comments
 (0)