Skip to content

Commit f70427c

Browse files
authored
1 parent b361eb7 commit f70427c

7 files changed

+1130
-59
lines changed

changelog.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
- Started movement of docs from README.md and docs directory to
99
the newdocs directory with a shorter README.md.
1010
- [Issue 1059](https://github.com/jackdewinter/pymarkdown/issues/1059)
11-
- Added updated pre-commit documentation.
11+
- Complete redo of pre-commit documentation.
12+
- [Issue 1070](https://github.com/jackdewinter/pymarkdown/issues/1070)
13+
- Complete redo of advanced configuration documentation.
1214

1315
### Fixed
1416

newdocs/.pymarkdown.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,7 @@ plugins:
88
enabled: false
99
list-anchored-indent:
1010
enabled: true
11+
12+
# "list-marker-space" : {
13+
# "enabled": false
14+
# },

newdocs/clean.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"enabled": true,
55
"code_block_line_length" : 160
66
},
7-
"list-marker-space" : {
7+
"ul-indent" : {
88
"enabled": false
99
},
1010
"list-anchored-indent" : {

newdocs/src/advanced_configuration.md

Lines changed: 1114 additions & 52 deletions
Large diffs are not rendered by default.

newdocs/src/advanced_extensions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ Other things that will be added:
77

88
- ensure solid documentation on each extensions
99
- ensure each extension has good examples
10+
11+
- move Pragma Extension and Front-Matter Extension from user guide into here, with
12+
teaser left there

newdocs/src/advanced_pre-commit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ This section relates to configuration files, as they are described in the
203203
document on [Advanced Configuration](./advanced_configuration.md#configuration-files).
204204
If you have not read that document to understand how PyMarkdown handles
205205
configuration files, please read that document before proceeding. Note that
206-
while we can specify configuration files with [different internal formats](./advanced_configuration.md#different-types),
206+
while we can specify configuration files with [different internal formats](./advanced_configuration.md#configuration-file-types),
207207
the following configuration examples are going to specify a JSON configuration file
208208
named `pymarkdown.json`.
209209

@@ -466,7 +466,7 @@ on these subjects.
466466

467467
### Command Line Arguments Vs Configuration File
468468

469-
As part of our documentation on [Advanced Configuration](./advanced_configuration.md#command-line-arguments-vs-configuration-file),
469+
As part of our documentation on [Advanced Configuration](./advanced_configuration.md#command-line-vs-configuration-file),
470470
we delve into this topic, providing our views on why to choose configuration files
471471
over command line arguments. There is no cut-and-dried answer that we can provide
472472
for everyone. Your own team's context is important.

newdocs/src/user-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ In addition to enabling and disabling rules, many of the rules have extra config
590590
that allow you to adjust their
591591
default values to meet your needs. Information on how to set that configuration
592592
on
593-
a per rule basis is covered in the document [Advanced Configuration](./advanced_configuration.md).
593+
a per rule basis is covered in the document [Advanced Configuration](./advanced_configuration.md#rule-plugins).
594594
For other information
595595
about rules and their capabilities, consult the [Advanced Rules Guide](./advanced_plugins.md).
596596
That guide covers these topics in more detail, including a list of all rules that
@@ -669,7 +669,7 @@ of configuration
669669
files is simple, there are a fair number of interactions to consider
670670
when supplying configuration. As such, this is more fully covered in the
671671
[Advanced Configuration](./advanced_configuration.md)
672-
document.
672+
document, especially the section on the [configuration files](./advanced_configuration.md#configuration-files).
673673

674674
##### --set (configuration)
675675

@@ -678,7 +678,7 @@ to explicitly set for
678678
the current execution of the PyMarkdown application. While the basic usage of configuration
679679
files is typically simple, there are a fair number of interactions to consider
680680
when supplying configuration. As such, this is more fully covered in the
681-
[Advanced Configuration](./advanced_configuration.md)
681+
[Advanced Configuration](./advanced_configuration.md#specific-command-line-settings)
682682
section of this documentation.
683683

684684
##### --strict-config (configuration)

0 commit comments

Comments
 (0)