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
+24-6
Original file line number
Diff line number
Diff line change
@@ -6,16 +6,34 @@ The repository uses Jekyll to generate HTML of the Markdown text files.
6
6
7
7
## Adding pages
8
8
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.
10
10
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:
14
12
```
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
15
26
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
+
```
17
35
18
-
TODO
36
+
The site is now accessible from http://127.0.0.1:4000/docs/.
0 commit comments