Skip to content

Commit 713aedd

Browse files
authored
Update README.md
Signed-off-by: Mericio <218162243+simihablo@users.noreply.github.com>
1 parent 27c0ce5 commit 713aedd

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ Explore tutorials and documentation by product in the https://docs.layer5.io web
4646
<summary><h3>Build Docs with Golang</h3></summary>
4747
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>
4848

49-
Now to setup and run the site locally run:
49+
Now to setup and run the site locally execute:
5050

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
5454

5555
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.
5656

@@ -70,7 +70,7 @@ Running the site locally is simple. Provided you have Docker installed, clone th
7070

7171
<details>
7272
73-
<summary><h3>Contribution Guidelines</h3>
73+
<summary><h3>Contribution Guidelines</h3></summary>
7474

7575
A detailed contribution guide for Layer5 Docs.
7676

@@ -80,22 +80,20 @@ Documentation content is written in Markdown and you'll find all files listed un
8080

8181
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.
8282

83-
```yaml
83+
<pre><code language="yaml">
8484
---
8585
title: 'My Title'
8686
description: "A thorough, yet succinct description of the page's contents"
8787
---
88-
```
88+
</code></pre>
8989

9090
The significant keys in the YAML frontmatter are:
9191

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>&nbsp;</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
9997

10098
### Uploading Images to the site
10199

@@ -109,7 +107,7 @@ To display images in a pop-up modal, use the following syntax: `![alt text](/pat
109107
### Adding Alert to the site
110108

111109
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>
113111

114112
- `type="danger"`: Alert used to indicate something related to security.
115113
- `type="info"`: Alert used to write some information.
@@ -184,7 +182,7 @@ Low-level ReST API reference for extending Layer5 Cloud.
184182
</details>
185183

186184
<details>
187-
<summary><h3>Kanvas Section: Information Architecture</h3>
185+
<summary><h3>Kanvas Section: Information Architecture</h3></summary>
188186

189187
### Getting Started with Designs
190188

0 commit comments

Comments
 (0)