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
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,11 +46,11 @@ Explore tutorials and documentation by product in the https://docs.layer5.io web
46
46
<summary><h3>Build Docs with Golang</h3></summary>
47
47
If your local development environment has a supported version (v1.21.0+) of Golang installed, next you'll need to install extended Hugo version as it has necessary SCSS/SASS support. Find all the Hugo packages here: <https://github.com/gohugoio/hugo/releases/tag/v0.120.4>
48
48
49
-
Now to setup and run the site locally run:
49
+
Now to setup and run the site locally execute:
50
50
51
-
`make setup` followed by `make site`
52
-
53
-
...and then visit <http://localhost:1313>.
51
+
1.`make setup`
52
+
2.`make site`
53
+
3.visit http://localhost:1313
54
54
55
55
If you pull down new code from GitHub, you will occasionally need to run `make setup` again. Otherwise, there's no need to re-run `make setup` each time the site is run, you can just run `make site` to get it going and have it automatically reload as you make and save site edits.
56
56
@@ -70,7 +70,7 @@ Running the site locally is simple. Provided you have Docker installed, clone th
@@ -80,22 +80,20 @@ Documentation content is written in Markdown and you'll find all files listed un
80
80
81
81
To create a new page with Markdown, create a file ending in `.md` in a `site/<subdirectory>`. The path in the content directory will be the URL route. For example, `site/docs/hello.md` will be served from the `/docs/hello` URL.
82
82
83
-
```yaml
83
+
<pre><codelanguage="yaml">
84
84
---
85
85
title: 'My Title'
86
86
description: "A thorough, yet succinct description of the page's contents"
87
87
---
88
-
```
88
+
</code></pre>
89
89
90
90
The significant keys in the YAML frontmatter are:
91
91
92
-
`title` (string) - This is the title of the page that will be set in the HTML title.
93
-
`description` (string) - This is a description of the page that will be set in the HTML description.
94
-
`permalink` (string - relative file path) - canonical location of the page
95
-
`category` (string) - section to which the page belongs.
96
-
`redirect_from` (string - relative file path) - in case the page was previously available elsewhere
97
-
98
-
<div> </div>
92
+
-`title` (string) - This is the title of the page that will be set in the HTML title.
93
+
-`description` (string) - This is a description of the page that will be set in the HTML description.
94
+
-`permalink` (string - relative file path) - canonical location of the page
95
+
-`category` (string) - section to which the page belongs.
96
+
-`redirect_from` (string - relative file path) - in case the page was previously available elsewhere
99
97
100
98
### Uploading Images to the site
101
99
@@ -109,7 +107,7 @@ To display images in a pop-up modal, use the following syntax: `![alt text](/pat
109
107
### Adding Alert to the site
110
108
111
109
Use the following Syntax to add an Alert:
112
-
`{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}`
110
+
<code>{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}</code>
113
111
114
112
-`type="danger"`: Alert used to indicate something related to security.
115
113
-`type="info"`: Alert used to write some information.
@@ -184,7 +182,7 @@ Low-level ReST API reference for extending Layer5 Cloud.
184
182
</details>
185
183
186
184
<details>
187
-
<summary><h3>Kanvas Section: Information Architecture</h3>
185
+
<summary><h3>Kanvas Section: Information Architecture</h3></summary>
0 commit comments