Skip to content

Commit 88dd566

Browse files
authored
feature (#85): add basic style guide for design elements (#100)
1 parent ada000a commit 88dd566

File tree

2 files changed

+152
-1
lines changed

2 files changed

+152
-1
lines changed

src/.vuepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ const sidebar = {
8080
{
8181
title: 'Contribute to the Docs',
8282
collapsable: true,
83-
children: ['writing-guide']
83+
children: ['writing-guide', 'doc-style-guide']
8484
}
8585
],
8686
api: [

src/guide/doc-style-guide.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# Documentation Style Guide
2+
3+
This guide will provide an overview of different design elements that are available for your use in creating documentation.
4+
5+
## Alerts
6+
7+
VuePress provides a custom container plugin to create alert boxes. There are four types:
8+
9+
- **Info**: Provide information that is neutral
10+
- **Tip**: Provide information that is positive and encouraged
11+
- **Warning**: Provide information that users should be aware of as there is a low to moderate
12+
- **Danger**: Provide information that is negative and has a high risk to the user
13+
14+
**Markdown Examples**
15+
16+
```
17+
::: info
18+
You can find more information at this site.
19+
:::
20+
21+
::: tip
22+
This is a great tip to remember!
23+
:::
24+
25+
::: warning
26+
This is something to be cautious of.
27+
:::
28+
29+
::: danger DANGER
30+
This is something we do not recommend. Use at your own risk.
31+
:::
32+
```
33+
34+
**Rendered Markdown**
35+
36+
::: info
37+
You can find more information at this site.
38+
:::
39+
40+
::: tip
41+
This is a great tip to remember!
42+
:::
43+
44+
::: warning
45+
This is something to be cautious of.
46+
:::
47+
48+
::: danger DANGER
49+
This is something we do not recommend. Use at your own risk.
50+
:::
51+
52+
## Code Blocks
53+
54+
VuePress uses Prism to provide language syntax highlighting by appending the language to the beginning backticks of a code block:
55+
56+
**Markdown Example**
57+
58+
````
59+
```js
60+
export default {
61+
name: 'MyComponent'
62+
}
63+
```
64+
````
65+
66+
**Rendered Output**
67+
```js
68+
export default {
69+
name: 'MyComponent'
70+
}
71+
```
72+
73+
### Line Highlighting
74+
75+
To add line highlighting to your code blocks, you need to append the line number in curly braces.
76+
77+
#### Single Line
78+
79+
**Markdown Example**
80+
81+
````
82+
```js{2}
83+
export default {
84+
name: 'MyComponent',
85+
props: {
86+
type: String,
87+
item: Object
88+
}
89+
}
90+
```
91+
````
92+
93+
**Rendered Markdown**
94+
95+
```js{2}
96+
export default {
97+
name: 'MyComponent',
98+
props: {
99+
type: String,
100+
item: Object
101+
}
102+
}
103+
```
104+
105+
#### Group of Lines
106+
107+
````
108+
```js{4-7}
109+
export default {
110+
name: 'MyComponent',
111+
props: {
112+
type: String,
113+
item: Object
114+
}
115+
}
116+
```
117+
````
118+
119+
```js{4-5}
120+
export default {
121+
name: 'MyComponent',
122+
props: {
123+
type: String,
124+
item: Object
125+
}
126+
}
127+
```
128+
129+
#### Multiple Sections
130+
131+
````
132+
```js{2,4-5}
133+
export default {
134+
name: 'MyComponent',
135+
props: {
136+
type: String,
137+
item: Object
138+
}
139+
}
140+
```
141+
````
142+
143+
```js{2,4-5}
144+
export default {
145+
name: 'MyComponent',
146+
props: {
147+
type: String,
148+
item: Object
149+
}
150+
}
151+
```

0 commit comments

Comments
 (0)