Skip to content

Commit ae228f5

Browse files
alemorvansspencerwire
alemorvan
and
sspencerwire
authored
Fix/linter (#1635)
* fix: fix linter problems - nested list - list - trailing whitespaces - remove $ on online command (no return) as suggested by linter I also add the markdown extension keys (++ctrl+a++). It could be better for us to use pure markdown (to test in pdf to see how it's rendering) * feat: add a markdownlint configuration file for the repository * fix: review linter of advanced commands * fix: review linter of vi * fix: review linter and style (prompt style) of users chapter * # Update `rockydocs_formatting.md` keyboard section (#1634) * Remove the references of <kbd>key</kbd> and replace with the markdown equivalent ++key++ * provide a link to the available key section --------- Co-authored-by: sspencerwire <[email protected]>
1 parent a9f6e81 commit ae228f5

File tree

5 files changed

+548
-266
lines changed

5 files changed

+548
-266
lines changed

‎.markdownlint.yml

+269
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,269 @@
1+
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
2+
# Example markdownlint configuration with all properties set to their default value
3+
4+
# Default state for all rules
5+
default: true
6+
7+
# Path to configuration file to extend
8+
extends: null
9+
10+
# MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md001.md
11+
MD001: true
12+
13+
# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md003.md
14+
MD003:
15+
# Heading style
16+
style: "consistent"
17+
18+
# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md004.md
19+
MD004:
20+
# List style
21+
style: "consistent"
22+
23+
# MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md005.md
24+
MD005: true
25+
26+
# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md007.md
27+
MD007:
28+
# Spaces for indent
29+
indent: 4
30+
# Whether to indent the first level of the list
31+
start_indented: false
32+
# Spaces for first level indent (when start_indented is set)
33+
start_indent: 2
34+
35+
# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md009.md
36+
MD009:
37+
# Spaces for line break
38+
br_spaces: 2
39+
# Allow spaces for empty lines in list items
40+
list_item_empty_lines: false
41+
# Include unnecessary breaks
42+
strict: false
43+
44+
# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md010.md
45+
MD010:
46+
# Include code blocks
47+
code_blocks: true
48+
# Fenced code languages to ignore
49+
ignore_code_languages: []
50+
# Number of spaces for each hard tab
51+
spaces_per_tab: 1
52+
53+
# MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md011.md
54+
MD011: true
55+
56+
# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md012.md
57+
MD012:
58+
# Consecutive blank lines
59+
maximum: 1
60+
61+
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md
62+
MD013: false
63+
# Number of characters
64+
# line_length: 80
65+
# Number of characters for headings
66+
# heading_line_length: 80
67+
# Number of characters for code blocks
68+
# code_block_line_length: 80
69+
# Include code blocks
70+
# code_blocks: true
71+
# Include tables
72+
# tables: true
73+
# Include headings
74+
# headings: true
75+
# Strict length checking
76+
# strict: false
77+
# Stern length checking
78+
# stern: false
79+
80+
# MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md014.md
81+
MD014: true
82+
83+
# MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md018.md
84+
MD018: true
85+
86+
# MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md019.md
87+
MD019: true
88+
89+
# MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md020.md
90+
MD020: true
91+
92+
# MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md021.md
93+
MD021: true
94+
95+
# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md022.md
96+
MD022:
97+
# Blank lines above heading
98+
lines_above: 1
99+
# Blank lines below heading
100+
lines_below: 1
101+
102+
# MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md023.md
103+
MD023: true
104+
105+
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md024.md
106+
MD024:
107+
# Only check sibling headings
108+
allow_different_nesting: false
109+
# Only check sibling headings
110+
siblings_only: false
111+
112+
# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md025.md
113+
MD025:
114+
# Heading level
115+
level: 1
116+
# RegExp for matching title in front matter
117+
#front_matter_title: "^\\s*title\\s*[:=]"
118+
front_matter_title: ""
119+
120+
# MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md026.md
121+
MD026:
122+
# Punctuation characters
123+
punctuation: ".,;:!。，；：！"
124+
125+
# MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md027.md
126+
MD027: true
127+
128+
# MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md028.md
129+
MD028: true
130+
131+
# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md029.md
132+
MD029:
133+
# List style
134+
style: "one_or_ordered"
135+
136+
# MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md030.md
137+
MD030:
138+
# Spaces for single-line unordered list items
139+
ul_single: 1
140+
# Spaces for single-line ordered list items
141+
ol_single: 1
142+
# Spaces for multi-line unordered list items
143+
ul_multi: 1
144+
# Spaces for multi-line ordered list items
145+
ol_multi: 1
146+
147+
# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md031.md
148+
MD031:
149+
# Include list items
150+
list_items: true
151+
152+
# MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md032.md
153+
MD032: true
154+
155+
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md033.md
156+
MD033:
157+
# Allowed elements
158+
allowed_elements: []
159+
160+
# MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md034.md
161+
MD034: true
162+
163+
# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md035.md
164+
MD035:
165+
# Horizontal rule style
166+
style: "consistent"
167+
168+
# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md036.md
169+
MD036:
170+
# Punctuation characters
171+
punctuation: ".,;:!?。，；：！？"
172+
173+
# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md037.md
174+
MD037: true
175+
176+
# MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md038.md
177+
MD038: true
178+
179+
# MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md039.md
180+
MD039: true
181+
182+
# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md040.md
183+
MD040:
184+
# List of languages
185+
allowed_languages: []
186+
# Require language only
187+
language_only: false
188+
189+
# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md041.md
190+
MD041:
191+
# Heading level
192+
level: 1
193+
# RegExp for matching title in front matter
194+
front_matter_title: "^\\s*title\\s*[:=]"
195+
196+
# MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md042.md
197+
MD042: true
198+
199+
# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md043.md
200+
MD043: false
201+
# List of headings
202+
# headings: []
203+
# Match case of headings
204+
# match_case: false
205+
206+
# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md044.md
207+
MD044:
208+
# List of proper names
209+
names: []
210+
# Include code blocks
211+
code_blocks: true
212+
# Include HTML elements
213+
html_elements: true
214+
215+
# MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md045.md
216+
MD045: true
217+
218+
# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md046.md
219+
# Disabled for the use of admonitions
220+
MD046: false
221+
# Block style
222+
# style: "consistent"
223+
224+
# MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md047.md
225+
MD047: true
226+
227+
# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md048.md
228+
MD048:
229+
# Code fence style
230+
style: "consistent"
231+
232+
# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md049.md
233+
MD049:
234+
# Emphasis style
235+
style: "consistent"
236+
237+
# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md050.md
238+
MD050:
239+
# Strong style
240+
style: "consistent"
241+
242+
# MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md051.md
243+
MD051: true
244+
245+
# MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md052.md
246+
MD052:
247+
# Include shortcut syntax
248+
shortcut_syntax: false
249+
250+
# MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md053.md
251+
MD053:
252+
# Ignored definitions
253+
ignored_definitions:
254+
- "//"
255+
256+
# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md054.md
257+
MD054:
258+
# Allow autolinks
259+
autolink: true
260+
# Allow inline links and images
261+
inline: true
262+
# Allow full reference links and images
263+
full: true
264+
# Allow collapsed reference links and images
265+
collapsed: true
266+
# Allow shortcut reference links and images
267+
shortcut: true
268+
# Allow URLs as inline links
269+
url_inline: true

‎docs/books/admin_guide/01-presentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In this chapter you will learn about GNU/Linux distributions.
1919

2020
:checkered_flag: **generalities**, **linux**, **distributions**
2121

22-
**Knowledge**: :star:
22+
**Knowledge**: :star:
2323

2424
**Complexity**: :star:
2525

‎docs/books/admin_guide/04-advanced-commands.md

+40-41
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Advanced Linux Commands
33
---
4-
<!-- markdownlint-disable MD033 -->
54

65
# Advanced Commands for Linux users
76

@@ -117,7 +116,7 @@ xargs
117116
use of xargs
118117
```
119118

120-
The `xargs` command waits for an input from the standard **stdin** input. Three lines are entered. The end of the user input is specified to `xargs` by the keystroke sequence <kbd>CTRL</kbd>+<kbd>D</kbd>. `xargs` then executes the default command `echo` followed by the three arguments corresponding to the user input, namely:
119+
The `xargs` command waits for an input from the standard **stdin** input. Three lines are entered. The end of the user input is specified to `xargs` by the keystroke sequence ++ctrl+d++. `xargs` then executes the default command `echo` followed by the three arguments corresponding to the user input, namely:
121120

122121
```bash
123122
$ echo "use" "of" "xargs"
@@ -221,51 +220,51 @@ The `yum-utils` package is a collection of utilities, built for `yum` by various
221220

222221
While `yum` has been replaced by `dnf` in Rocky Linux 8, the package name has remained `yum-utils`, although it can be installed as `dnf-utils` as well. These are classic YUM utilities implemented as CLI shims on top of DNF to maintain backwards compatibility with `yum-3`.
223222

224-
Here are some examples of these utilities:
223+
Here are some examples of these utilities.
225224

226-
* `repoquery` command
225+
### `repoquery` command
227226

228227
The `repoquery` command is used to query the packages in the repository.
229228

230229
Examples of use:
231230

232-
* Display the dependencies of a package (it can be a software package that has been installed or not installed), equivalent to `dnf deplist <package-name>`
233-
234-
```bash
235-
repoquery --requires <package-name>
236-
```
237-
238-
* Display the files provided by an installed package (does not work for packages that are not installed), equivalent to `rpm -ql <package-name>`
239-
240-
```bash
241-
$ repoquery -l yum-utils
242-
/etc/bash_completion.d
243-
/etc/bash_completion.d/yum-utils.bash
244-
/usr/bin/debuginfo-install
245-
/usr/bin/find-repos-of-install
246-
/usr/bin/needs-restarting
247-
/usr/bin/package-cleanup
248-
/usr/bin/repo-graph
249-
/usr/bin/repo-rss
250-
/usr/bin/repoclosure
251-
/usr/bin/repodiff
252-
/usr/bin/repomanage
253-
/usr/bin/repoquery
254-
/usr/bin/reposync
255-
/usr/bin/repotrack
256-
/usr/bin/show-changed-rco
257-
/usr/bin/show-installed
258-
/usr/bin/verifytree
259-
/usr/bin/yum-builddep
260-
/usr/bin/yum-config-manager
261-
/usr/bin/yum-debug-dump
262-
/usr/bin/yum-debug-restore
263-
/usr/bin/yum-groups-manager
264-
/usr/bin/yumdownloader
265-
…
266-
```
267-
268-
* `yumdownloader` command:
231+
* Display the dependencies of a package (it can be a software package that has been installed or not installed), equivalent to `dnf deplist <package-name>`
232+
233+
```bash
234+
repoquery --requires <package-name>
235+
```
236+
237+
* Display the files provided by an installed package (does not work for packages that are not installed), equivalent to `rpm -ql <package-name>`
238+
239+
```bash
240+
$ repoquery -l yum-utils
241+
/etc/bash_completion.d
242+
/etc/bash_completion.d/yum-utils.bash
243+
/usr/bin/debuginfo-install
244+
/usr/bin/find-repos-of-install
245+
/usr/bin/needs-restarting
246+
/usr/bin/package-cleanup
247+
/usr/bin/repo-graph
248+
/usr/bin/repo-rss
249+
/usr/bin/repoclosure
250+
/usr/bin/repodiff
251+
/usr/bin/repomanage
252+
/usr/bin/repoquery
253+
/usr/bin/reposync
254+
/usr/bin/repotrack
255+
/usr/bin/show-changed-rco
256+
/usr/bin/show-installed
257+
/usr/bin/verifytree
258+
/usr/bin/yum-builddep
259+
/usr/bin/yum-config-manager
260+
/usr/bin/yum-debug-dump
261+
/usr/bin/yum-debug-restore
262+
/usr/bin/yum-groups-manager
263+
/usr/bin/yumdownloader
264+
…
265+
```
266+
267+
### `yumdownloader` command
269268

270269
The `yumdownloader` command downloads RPM packages from the repositories. Equivalent to `dnf download --downloadonly --downloaddir ./ package-name`
271270

0 commit comments

Comments
 (0)