chore: Update links to mkdocs-simple docsite
And also make them correspond to the version of mkdocs-simple that this package is currently built on top of.
This commit is contained in:
parent
861ba98942
commit
6c91692e48
@ -86,7 +86,7 @@ steps:
|
||||
# [repository site](https://code.studioinfinity.org/glen/mkdocs-semiliterate).
|
||||
# Pull requests are welcome as well. If you're new to contributing to open-source
|
||||
# projects, `mkdocs-simple-plugin` has a very nice
|
||||
# [tutorial](https://athackst.github.io/mkdocs-simple-plugin/CONTRIBUTING/).
|
||||
# [tutorial](https://althack.dev/mkdocs-simple-plugin/v{! setup.cfg { extract: {start: 'mkdocs~=', stop: '(\d*\.\d*\.?\d*)'}, ensurelines: false} !}/CONTRIBUTING/).
|
||||
#
|
||||
# ### Publishing
|
||||
#
|
||||
|
@ -1,7 +1,8 @@
|
||||
# ![Dreaming of integrated documentation](assets/icons8-ask-question-100.png) MkDocs semiliterate Plugin
|
||||
|
||||
This plugin for [MkDocs](http://mkdocs.org) is an extension of Allison Thackston's excellent [mkdocs-simple-plugin](https://athackst.github.io/mkdocs-simple-plugin). It allows you to include content from one file into another (via `{! ... !}` syntax), using exactly the same extraction specification that the `simple` plugin already uses for identifying documentation in source files.
|
||||
This plugin for [MkDocs](http://mkdocs.org) is an extension of Allison Thackston's excellent [mkdocs-simple-plugin](https://www.althack.dev/mkdocs-simple-plugin/). It allows you to include content from one file into another (via `{! ... !}` syntax), using exactly the same extraction specification that the `simple` plugin already uses for identifying documentation in source files.
|
||||
<!-- repo: --><!-- site: The current version of mkdocs-semiliterate is {! setup.cfg { extract: {start: name}, terminate: '(\d*\.\d*\.\d*)', ensurelines: false} !}. -->
|
||||
<!-- repo: --><!-- site: It is built on mkdocs-simple-plugin v{! setup.cfg { extract: {start: 'mkdocs~=', stop: '(\d*\.\d*\.?\d*)'}, ensurelines: false} !}. -->
|
||||
|
||||
## Rationale
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
""" md
|
||||
r""" md
|
||||
## Usage
|
||||
|
||||
Once this plugin is [installed](../README.md#installation), just replace
|
||||
@ -6,7 +6,10 @@ the plugin name `simple` with `semiliterate` in your `mkdocs.yml` file.
|
||||
It accepts all of the same parameters, so `mkdocs` will still work as before,
|
||||
and you will have immediate access to all of the following extensions.
|
||||
(Note that this documentation assumes a familiarity with the
|
||||
[usage](https://athackst.github.io/mkdocs-simple-plugin/mkdocs_simple_plugin/plugin/)
|
||||
[usage](https://althack.dev/mkdocs-simple-plugin/v{! ../setup.cfg {
|
||||
extract: {start: 'mkdocs~=', stop: '(\d*\.\d*\.?\d*)'},
|
||||
ensurelines: false
|
||||
} !}/mkdocs_simple_plugin/plugin/)
|
||||
of the `simple` plugin.)
|
||||
"""
|
||||
|
||||
@ -83,7 +86,7 @@ enclosed in single or double quotes. Note that FILENAME is interpreted relative
|
||||
to the directory in which the file containing the `{! .. !}` expression
|
||||
resides. The YAML is interpreted exactly as the extraction options to a
|
||||
`semiliterate` item as
|
||||
[documented](https://athackst.github.io/mkdocs-simple-plugin/mkdocs_simple_plugin/plugin/index.html#semiliterate)
|
||||
[documented](https://althack.dev/mkdocs-simple-plugin/v{! ../setup.cfg { extract: {start: 'mkdocs~=', stop: '(\d*\.\d*\.?\d*)'}, ensurelines: false} !}/mkdocs_simple_plugin/plugin/index.html#semiliterate)
|
||||
for the `simple` extension, subject to the extensions below. The text
|
||||
extracted from FILENAME is interpolated at the current location in the file
|
||||
currently being written. Recursive inclusion is supported.
|
||||
@ -97,9 +100,7 @@ For an example that uses more of the extraction parameters, the current
|
||||
version number of mkdocs-semiliterate is extracted into the
|
||||
[Overview](../README.md) of this documentation via
|
||||
|
||||
` {! ../README.md extract: { start: 'repo:.*(\{!.*!\})', stop: '' }
|
||||
terminate: Rationale
|
||||
!}`
|
||||
` {! ../README.md extract: { start: 'repo:.*(\{!.*!\})', stop: 'repo' } !}`
|
||||
|
||||
to take advantage of the beginning of the `setup.cfg` file:
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user