Skip to content

Commit 1966846

Browse files
authored
Update README.md
Signed-off-by: Mericio <218162243+simihablo@users.noreply.github.com>
1 parent 4005aa0 commit 1966846

File tree

1 file changed

+2
-49
lines changed

1 file changed

+2
-49
lines changed

README.md

Lines changed: 2 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -68,58 +68,11 @@ Running the site locally is simple. Provided you have Docker installed, clone th
6868
6969
</details>
7070

71-
<details>
7271
73-
<summary><h3>Contribution Guidelines</h3></summary>
74-
75-
A detailed contribution guide for Layer5 Docs.
76-
77-
### Editing Markdown Content
78-
79-
Documentation content is written in Markdown and you'll find all files listed under the /content directory.
80-
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-
83-
<pre><code language="yaml">
84-
---
85-
title: 'My Title'
86-
description: "A thorough, yet succinct description of the page's contents"
87-
---
88-
</code></pre>
89-
90-
The significant keys in the YAML frontmatter are:
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-
### Uploading Images to the site
72+
### Contribution Guidelines
9973

100-
To display images in a pop-up modal, use the following syntax: `![alt text](/path/to/image.svg)` or `<img src="" alt="" />`.
74+
**--> See https://docs.layer5.io/contributing <--** for a detailed contribution guide.
10175

102-
**Note:**
103-
104-
- For images to show correctly on subpages, always provide the complete image path.
105-
- When using the `<img />` tag, add `data-modal="false"` to prevent the image from opening in a modal e.g. a [logo](https://github.com/layer5io/docs/blob/0bef5a9a05214a9dda10d8a68431e41f5a36676d/layouts/partials/footer.html#L9).
106-
107-
### Adding Alert to the site
108-
109-
Use the following Syntax to add an Alert:
110-
<code>{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}</code>
111-
112-
- `type="danger"`: Alert used to indicate something related to security.
113-
- `type="info"`: Alert used to write some information.
114-
- `type="warning"`: Alert used to indicate a warning that might need attention.
115-
- `type="note"`: Alert used to indicate a neutral information.
116-
- `type="success"`: Alert used to indicate a positive information.
117-
118-
By default, if you don't specify a `title="Your Title"`, the title will be the same as the type name.
119-
120-
**Note-> Using an invalid alert type will lead to the default alert being used (i.e. success).**
121-
122-
</details>
12376

12477
## Documentation Structure
12578

0 commit comments

Comments
 (0)