mirror of
https://github.com/mkdocs/mkdocs.git
synced 2026-03-27 09:58:31 +07:00
Replace instances of ```no-highlight
This commit is contained in:
@@ -16,10 +16,6 @@ div.col-md-9 h1:first-of-type .headerlink {
|
||||
display: none;
|
||||
}
|
||||
|
||||
code.no-highlight {
|
||||
color: black;
|
||||
}
|
||||
|
||||
div.admonition.block>.admonition-title {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@@ -27,7 +27,7 @@ option to the path of the directory containing `main.html`. The path should be
|
||||
relative to the configuration file. For example, given this example project
|
||||
layout:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
mkdocs.yml
|
||||
docs/
|
||||
index.md
|
||||
@@ -326,7 +326,7 @@ for a page.
|
||||
|
||||
In this example we define a `source` property above the page title:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
source: generics.py
|
||||
mixins.py
|
||||
|
||||
@@ -764,7 +764,7 @@ directory called `MANIFEST.in` and `setup.py` beside the theme directory which
|
||||
contains an empty `__init__.py` file, a theme configuration file
|
||||
(`mkdocs_theme.yml`), and your template and media files.
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
.
|
||||
|-- MANIFEST.in
|
||||
|-- theme_name
|
||||
@@ -778,7 +778,7 @@ contains an empty `__init__.py` file, a theme configuration file
|
||||
The `MANIFEST.in` file should contain the following contents but with
|
||||
theme_name updated and any extra file extensions added to the include.
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
recursive-include theme_name *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff
|
||||
recursive-exclude * __pycache__
|
||||
recursive-exclude * *.py[co]
|
||||
@@ -1166,7 +1166,7 @@ translations, it only makes use of the binary `mo` files(s) for the specified
|
||||
locale. Therefore, when [packaging a theme], you would need to make the
|
||||
following addition to your `MANIFEST.in` file:
|
||||
|
||||
``` no-highlight
|
||||
```text
|
||||
recursive-include theme_name *.mo
|
||||
```
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ as you work on it. Make sure you're in the same directory as the `mkdocs.yml`
|
||||
configuration file, and then start the server by running the `mkdocs serve`
|
||||
command:
|
||||
|
||||
```bash
|
||||
```console
|
||||
$ mkdocs serve
|
||||
INFO - Building documentation...
|
||||
INFO - Cleaning site directory
|
||||
@@ -156,7 +156,7 @@ mkdocs build
|
||||
This will create a new directory, named `site`. Take a look inside the
|
||||
directory:
|
||||
|
||||
```bash
|
||||
```console
|
||||
$ ls site
|
||||
about fonts index.html license search.html
|
||||
css img js mkdocs sitemap.xml
|
||||
|
||||
@@ -48,7 +48,7 @@ with the GitHub account name. Therefore, you need working copies of two
|
||||
repositories on our local system. For example, consider the following file
|
||||
structure:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
my-project/
|
||||
mkdocs.yml
|
||||
docs/
|
||||
|
||||
@@ -11,7 +11,7 @@ manager, [pip], to be installed on your system.
|
||||
|
||||
You can check if you already have these installed from the command line:
|
||||
|
||||
```bash
|
||||
```console
|
||||
$ python --version
|
||||
Python 3.8.2
|
||||
$ pip --version
|
||||
@@ -61,7 +61,7 @@ pip install mkdocs
|
||||
You should now have the `mkdocs` command installed on your system. Run `mkdocs
|
||||
--version` to check that everything worked okay.
|
||||
|
||||
```bash
|
||||
```console
|
||||
$ mkdocs --version
|
||||
mkdocs, version 1.2.0 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8)
|
||||
```
|
||||
|
||||
@@ -14,7 +14,7 @@ the `mkdocs.yml` configuration file.
|
||||
|
||||
The simplest project you can create will look something like this:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
mkdocs.yml
|
||||
docs/
|
||||
index.md
|
||||
@@ -35,7 +35,7 @@ behavior.
|
||||
You can also create multi-page documentation, by creating several Markdown
|
||||
files:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
mkdocs.yml
|
||||
docs/
|
||||
index.md
|
||||
@@ -46,7 +46,7 @@ docs/
|
||||
The file layout you use determines the URLs that are used for the generated
|
||||
pages. Given the above layout, pages would be generated for the following URLs:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
/
|
||||
/about/
|
||||
/license/
|
||||
@@ -55,7 +55,7 @@ pages. Given the above layout, pages would be generated for the following URLs:
|
||||
You can also include your Markdown files in nested directories if that better
|
||||
suits your documentation layout.
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
docs/
|
||||
index.md
|
||||
user-guide/getting-started.md
|
||||
@@ -66,7 +66,7 @@ docs/
|
||||
Source files inside nested directories will cause pages to be generated with
|
||||
nested URLs, like so:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
/
|
||||
/user-guide/getting-started/
|
||||
/user-guide/configuration-options/
|
||||
@@ -111,7 +111,7 @@ your navigation menu sorted differently.
|
||||
|
||||
A minimal navigation configuration could look like this:
|
||||
|
||||
```no-highlight
|
||||
```yaml
|
||||
nav:
|
||||
- 'index.md'
|
||||
- 'about.md'
|
||||
@@ -127,7 +127,7 @@ level and with their titles inferred from the contents of the Markdown file or,
|
||||
if no title is defined within the file, of the file name. To override the title
|
||||
in the `nav` setting add a title right before the filename.
|
||||
|
||||
```no-highlight
|
||||
```yaml
|
||||
nav:
|
||||
- Home: 'index.md'
|
||||
- About: 'about.md'
|
||||
@@ -140,7 +140,7 @@ within the page itself.
|
||||
Navigation sub-sections can be created by listing related pages together under a
|
||||
section title. For example:
|
||||
|
||||
```no-highlight
|
||||
```yaml
|
||||
nav:
|
||||
- Home: 'index.md'
|
||||
- 'User Guide':
|
||||
@@ -206,7 +206,7 @@ When linking between pages in the documentation you can simply use the regular
|
||||
Markdown [linking][links] syntax, including the *relative path* to the Markdown
|
||||
document you wish to link to.
|
||||
|
||||
```no-highlight
|
||||
```markdown
|
||||
Please see the [project license](license.md) for further details.
|
||||
```
|
||||
|
||||
@@ -223,7 +223,7 @@ them to your production server.
|
||||
If the target documentation file is in another directory you'll need to make
|
||||
sure to include any relative directory path in the link.
|
||||
|
||||
```no-highlight
|
||||
```markdown
|
||||
Please see the [project license](../about/license.md) for further details.
|
||||
```
|
||||
|
||||
@@ -232,7 +232,7 @@ Markdown documents. You can use that ID to link to a section within a target
|
||||
document by using an anchor link. The generated HTML will correctly transform
|
||||
the path portion of the link, and leave the anchor portion intact.
|
||||
|
||||
```no-highlight
|
||||
```markdown
|
||||
Please see the [project license](about.md#license) for further details.
|
||||
```
|
||||
|
||||
@@ -313,7 +313,7 @@ For example, if your project documentation needed to include a [GitHub pages
|
||||
CNAME file] and a PNG formatted screenshot image then your file layout might
|
||||
look as follows:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
mkdocs.yml
|
||||
docs/
|
||||
CNAME
|
||||
@@ -398,7 +398,7 @@ a document must be `---`. The meta-data ends at the first line containing an
|
||||
end deliminator (either `---` or `...`). The content between the delimiters is
|
||||
parsed as [YAML].
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
---
|
||||
title: My Document
|
||||
summary: A brief description of my document.
|
||||
@@ -427,7 +427,7 @@ MultiMarkdown style meta-data uses a format first introduced by the
|
||||
[MultiMarkdown] project. The data consists of a series of keywords and values
|
||||
defined at the beginning of a Markdown document, like this:
|
||||
|
||||
```no-highlight
|
||||
```text
|
||||
Title: My Document
|
||||
Summary: A brief description of my document.
|
||||
Authors: Waylan Limberg
|
||||
@@ -471,7 +471,7 @@ only useful for simple tabular data.
|
||||
|
||||
A simple table looks like this:
|
||||
|
||||
```no-highlight
|
||||
```markdown
|
||||
First Header | Second Header | Third Header
|
||||
------------ | ------------- | ------------
|
||||
Content Cell | Content Cell | Content Cell
|
||||
@@ -480,7 +480,7 @@ Content Cell | Content Cell | Content Cell
|
||||
|
||||
If you wish, you can add a leading and tailing pipe to each line of the table:
|
||||
|
||||
```no-highlight
|
||||
```markdown
|
||||
| First Header | Second Header | Third Header |
|
||||
| ------------ | ------------- | ------------ |
|
||||
| Content Cell | Content Cell | Content Cell |
|
||||
@@ -489,7 +489,7 @@ If you wish, you can add a leading and tailing pipe to each line of the table:
|
||||
|
||||
Specify alignment for each column by adding colons to separator lines:
|
||||
|
||||
```no-highlight
|
||||
```markdown
|
||||
First Header | Second Header | Third Header
|
||||
:----------- |:-------------:| -----------:
|
||||
Left | Center | Right
|
||||
@@ -513,7 +513,7 @@ blocks without indentation.
|
||||
The first line should contain 3 or more backtick (`` ` ``) characters, and the
|
||||
last line should contain the same number of backtick characters (`` ` ``):
|
||||
|
||||
````no-highlight
|
||||
````markdown
|
||||
```
|
||||
Fenced code blocks are like Standard
|
||||
Markdown’s regular code blocks, except that
|
||||
@@ -526,7 +526,7 @@ code block.
|
||||
With this approach, the language can optionally be specified on the first line
|
||||
after the backticks which informs any syntax highlighters of the language used:
|
||||
|
||||
````no-highlight
|
||||
````markdown
|
||||
```python
|
||||
def fn():
|
||||
pass
|
||||
|
||||
Reference in New Issue
Block a user