File tree 2 files changed +33
-21
lines changed
2 files changed +33
-21
lines changed Original file line number Diff line number Diff line change @@ -10,19 +10,21 @@ tags:
10
10
---
11
11
12
12
# First level header Introduction
13
+
13
14
Description Here
14
15
15
- - https://docs.rockylinux.org/guides/contribute/
16
- - More detailed info: [ RockyLinux First-Time Contributor Guide] ( https://docs.rockylinux.org/guides/contribute/beginners/#first-time-contributor-guide )
16
+ - < https://docs.rockylinux.org/guides/contribute/ >
17
+ - More detailed info: [ RockyLinux First-Time Contributor Guide] ( https://docs.rockylinux.org/guides/contribute/beginners/#first-time-contributor-guide )
17
18
18
- !!! warning
19
+ !!! warning "Warning"
19
20
20
21
A warning admonition here
21
22
22
23
## Second level header
23
24
24
25
Your text here
25
- ```
26
+
27
+ ``` text
26
28
example code block here
27
29
```
28
30
@@ -33,15 +35,16 @@ Your text here
33
35
!!! note "Note Admonition Example"
34
36
35
37
Here is a note as opposed to a warning
36
-
37
38
38
39
## Third second level header
39
40
40
41
inline ticks for code keywords ` echo $SOMEVAR ` like so.
41
42
42
43
### deeper header here
44
+
43
45
Your text here
44
46
Example of code block with syntax highlighting for a specific language, bash in this case:
47
+
45
48
``` bash
46
49
echo $ENV_VAR
47
50
if [${wale} || ${sspencerwire} ]
54
57
55
58
single asteriks: * may*
56
59
57
- double asteriks: ** may**
60
+ double asterisk: ** may**
61
+
62
+ # # Conclusions
58
63
59
- # Conclusions:
60
64
It works great!
61
65
62
66
---
63
67
64
- # ## References/Footnotes:
65
- [14](https://rockylinux.org) (or use a bulleted list, numbered list, etc)
68
+ # ## References/Footnotes
69
+
70
+ [14](https://rockylinux.org) (or use a bulleted list, numbered list, etc.)
Original file line number Diff line number Diff line change 9
9
- 2nd tag
10
10
---
11
11
12
- # Some ideas regarding general structure of any technical doc:
12
+ # Some ideas regarding general structure of any technical doc
13
+
14
+ ## Preamble/Intro
13
15
14
- ## Preamble/Intro:
15
16
Goal, What to achieve
16
17
Why to achieve, desired results/benefits
17
18
measurable desired results/benefits
18
19
General process to be followed
19
20
Concerns, Warnings, Notes, Caveats
20
21
21
- ## Prerequsites:
22
+ ## Prerequsites
23
+
24
+ ## Special Terminology
22
25
23
- ## Special Terminology:
26
+ ## Process
24
27
25
- ## Process:
26
28
Detailed Process steps
27
- Try a link to a footnote/reference secton here
29
+ Try a link to a footnote/reference section here
30
+
31
+ ## Dependencies
28
32
29
- ## Dependencies:
30
33
Verified versions of software, libraries used/required
31
34
32
- ## Going Further:
35
+ ## Going Further
36
+
33
37
Links for additional customizations
34
38
35
- ## Conclusions:
39
+ ## Conclusions
40
+
36
41
It works great!
37
42
38
43
---
39
- ## Glossary:
40
44
41
- ## REFERENCES:
45
+ ## Glossary
46
+
47
+ ## REFERENCES
48
+
42
49
1 . Footnotes/Reference links (URLs, manpage websites, etc)
43
- 2 . Links to scripts, code and custom programs (for posterity in some cases if the originals might disappear )
50
+ 2 . Links to scripts, code and custom programs (for posterity in some cases if the originals might disappear)
44
51
45
52
## Plus all the things I've thought of in the past and can't remember
You can’t perform that action at this time.
0 commit comments