centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Apply new markdownlint rule table-pipe-style

Browse Source
This commit is contained in:
Oleh Prypin
2024-01-29 21:56:36 +01:00
parent 2426e7c897
commit 369dcc0aa1
3 changed files with 64 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.markdownlintrc
View File

@@ -26,5 +26,8 @@
"MD041": false, "MD041": false,
// Disable named references validation // Disable named references validation
"MD052": false "MD052": false,
// Table pipe style
"MD055": { "style": "no_leading_or_trailing" }
} }

110
docs/about/release-notes.md
View File

@@ -1111,11 +1111,11 @@ effect most users. However, if you have `use_directory_urls` set to `False`
for a MkDocs site hosted on a web server, most of your URLs will now be broken. for a MkDocs site hosted on a web server, most of your URLs will now be broken.
As you can see below, the new URLs are much more sensible. As you can see below, the new URLs are much more sensible.
| Markdown file | Old URL | New URL | Markdown file | Old URL | New URL
| --------------- | -------------------- | -------------- | --------------- | -------------------- | --------------
| `index.md` | `index.html` | `index.html` | `index.md` | `index.html` | `index.html`
| `foo.md` | `foo/index.html` | `foo.html` | `foo.md` | `foo/index.html` | `foo.html`
| `foo/bar.md` | `foo/bar/index.html` | `foo/bar.html` | `foo/bar.md` | `foo/bar/index.html` | `foo/bar.html`
Note that there has been no change to URLs or file paths when Note that there has been no change to URLs or file paths when
`use_directory_urls` is set to `True` (the default), except that MkDocs more `use_directory_urls` is set to `True` (the default), except that MkDocs more
@@ -1409,37 +1409,37 @@ version 1.0.
Any of the following old page variables should be updated to the new ones in Any of the following old page variables should be updated to the new ones in
user created and third-party templates: user created and third-party templates:
| Old Variable Name | New Variable Name | Old Variable Name | New Variable Name
| ----------------- | ----------------- | ----------------- | -----------------
| current_page | [page] | current_page | [page]
| page_title | page.title | page_title | page.title
| content | page.content | content | page.content
| toc | page.toc | toc | page.toc
| meta | page.meta | meta | page.meta
| canonical_url | page.canonical_url| canonical_url | page.canonical_url
| previous_page | page.previous_page| previous_page | page.previous_page
| next_page | page.next_page | next_page | page.next_page
[page]: ../dev-guide/themes.md#page [page]: ../dev-guide/themes.md#page
Additionally, a number of global variables have been altered and/or removed Additionally, a number of global variables have been altered and/or removed
and user created and third-party templates should be updated as outlined below: and user created and third-party templates should be updated as outlined below:
| Old Variable Name | New Variable Name or Expression | Old Variable Name | New Variable Name or Expression
| ----------------- | -------------------------------------- | ----------------- | --------------------------------------
| current_page | page | current_page | page
| include_nav | nav|length>1 | include_nav | nav|length>1
| include_next_prev | (page.next_page or page.previous_page) | include_next_prev | (page.next_page or page.previous_page)
| site_name | config.site_name | site_name | config.site_name
| site_author | config.site_author | site_author | config.site_author
| page_description | config.site_description | page_description | config.site_description
| repo_url | config.repo_url | repo_url | config.repo_url
| repo_name | config.repo_name | repo_name | config.repo_name
| site_url | config.site_url | site_url | config.site_url
| copyright | config.copyright | copyright | config.copyright
| google_analytics | config.google_analytics | google_analytics | config.google_analytics
| homepage_url | nav.homepage.url | homepage_url | nav.homepage.url
| favicon | {{ base_url }}/img/favicon.ico | favicon | {{ base_url }}/img/favicon.ico
#### Auto-Populated extra_css and extra_javascript Fully Deprecated. (#986) #### Auto-Populated extra_css and extra_javascript Fully Deprecated. (#986)
@@ -1506,16 +1506,16 @@ but may be removed in a future version.
Any of the following old page variables should be updated to the new ones in Any of the following old page variables should be updated to the new ones in
user created and third-party templates: user created and third-party templates:
| Old Variable Name | New Variable Name | Old Variable Name | New Variable Name
| ----------------- | ------------------ | ----------------- | ------------------
| current_page | [page] | current_page | [page]
| page_title | page.title | page_title | page.title
| content | page.content | content | page.content
| toc | page.toc | toc | page.toc
| meta | page.meta | meta | page.meta
| canonical_url | page.canonical_url | canonical_url | page.canonical_url
| previous_page | page.previous_page | previous_page | page.previous_page
| next_page | page.next_page | next_page | page.next_page
##### Global Context ##### Global Context
@@ -1559,21 +1559,21 @@ work for version 0.16, but may be removed in a future version. Use
Below is a summary of all of the changes made to the global context: Below is a summary of all of the changes made to the global context:
| Old Variable Name | New Variable Name or Expression | Old Variable Name | New Variable Name or Expression
| ----------------- | -------------------------------------- | ----------------- | --------------------------------------
| current_page | page | current_page | page
| include_nav | nav|length>1 | include_nav | nav|length>1
| include_next_prev | (page.next_page or page.previous_page) | include_next_prev | (page.next_page or page.previous_page)
| site_name | config.site_name | site_name | config.site_name
| site_author | config.site_author | site_author | config.site_author
| page_description | config.site_description | page_description | config.site_description
| repo_url | config.repo_url | repo_url | config.repo_url
| repo_name | config.repo_name | repo_name | config.repo_name
| site_url | config.site_url | site_url | config.site_url
| copyright | config.copyright | copyright | config.copyright
| google_analytics | config.google_analytics | google_analytics | config.google_analytics
| homepage_url | nav.homepage.url | homepage_url | nav.homepage.url
| favicon | {{ base_url }}/img/favicon.ico | favicon | {{ base_url }}/img/favicon.ico
#### Increased Template Customization. (#607) #### Increased Template Customization. (#607)

10
docs/user-guide/configuration.md
View File

@@ -1023,11 +1023,11 @@ plugins:
###### Options ###### Options
|Option|Description| Option | Description
|------|-----------| ------ | -----------
|`full`|Indexes the title, section headings, and full text of each page.| `full` | Indexes the title, section headings, and full text of each page.
|`sections`|Indexes the title and section headings of each page.| `sections` | Indexes the title and section headings of each page.
|`titles`|Indexes only the title of each page.| `titles` | Indexes only the title of each page.
**default**: `full` **default**: `full`