mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Added no-copy classes for directory listings
This commit is contained in:
parent
5421abee16
commit
b1ecde6a6c
@ -64,7 +64,7 @@ mkdocs new .
|
|||||||
|
|
||||||
This will create the following structure:
|
This will create the following structure:
|
||||||
|
|
||||||
```
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ index.md
|
│ └─ index.md
|
||||||
@ -118,7 +118,7 @@ first post. All blog posts are written with the [exact same Markdown flavor] as
|
|||||||
already included with Material for MkDocs. First, create a folder called `posts`
|
already included with Material for MkDocs. First, create a folder called `posts`
|
||||||
with a file called `hello-world.md`:
|
with a file called `hello-world.md`:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ ├─ posts/
|
│ ├─ posts/
|
||||||
|
@ -24,7 +24,7 @@ Alternatively, if you're running Material for MkDocs from within Docker, use:
|
|||||||
|
|
||||||
This will create the following structure:
|
This will create the following structure:
|
||||||
|
|
||||||
```
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ index.md
|
│ └─ index.md
|
||||||
|
@ -19,7 +19,7 @@ If you want to tweak some colors or change the spacing of certain elements,
|
|||||||
you can do this in a separate style sheet. The easiest way is by creating a
|
you can do this in a separate style sheet. The easiest way is by creating a
|
||||||
new style sheet file in the `docs` directory:
|
new style sheet file in the `docs` directory:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ stylesheets/
|
│ └─ stylesheets/
|
||||||
@ -39,7 +39,7 @@ extra_css:
|
|||||||
If you want to integrate another syntax highlighter or add some custom logic to
|
If you want to integrate another syntax highlighter or add some custom logic to
|
||||||
your theme, create a new JavaScript file in the `docs` directory:
|
your theme, create a new JavaScript file in the `docs` directory:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ javascripts/
|
│ └─ javascripts/
|
||||||
@ -87,7 +87,7 @@ of the original theme, as any file in the `overrides` directory will replace the
|
|||||||
file with the same name which is part of the original theme. Besides, further
|
file with the same name which is part of the original theme. Besides, further
|
||||||
assets may also be put in the `overrides` directory:
|
assets may also be put in the `overrides` directory:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ .icons/ # Bundled icon sets
|
├─ .icons/ # Bundled icon sets
|
||||||
├─ assets/
|
├─ assets/
|
||||||
@ -142,7 +142,7 @@ and location in the `overrides` directory. For example, to replace the original
|
|||||||
`footer.html` partial, create a new `footer.html` partial in the `overrides`
|
`footer.html` partial, create a new `footer.html` partial in the `overrides`
|
||||||
directory:
|
directory:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ overrides/
|
├─ overrides/
|
||||||
│ └─ partials/
|
│ └─ partials/
|
||||||
@ -160,7 +160,7 @@ template blocks, which are defined inside the templates and wrap specific
|
|||||||
features. In order to set up block overrides, create a `main.html` file inside
|
features. In order to set up block overrides, create a `main.html` file inside
|
||||||
the `overrides` directory:
|
the `overrides` directory:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ overrides/
|
├─ overrides/
|
||||||
│ └─ main.html
|
│ └─ main.html
|
||||||
|
@ -82,7 +82,7 @@ Next, add your `*.svg` icons into a subfolder of the `.icons` folder. Let's say
|
|||||||
you downloaded and unpacked the [Bootstrap] icon set, and want to add it to
|
you downloaded and unpacked the [Bootstrap] icon set, and want to add it to
|
||||||
your project documentation. The structure of your project should look like this:
|
your project documentation. The structure of your project should look like this:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ overrides/
|
├─ overrides/
|
||||||
│ └─ .icons/
|
│ └─ .icons/
|
||||||
|
@ -360,7 +360,7 @@ removed during the build process.
|
|||||||
For the official documentation, the [built-in privacy plugin] downloads the
|
For the official documentation, the [built-in privacy plugin] downloads the
|
||||||
following resources:
|
following resources:
|
||||||
|
|
||||||
``` { .sh id="example" }
|
``` { .sh .no-copy #example }
|
||||||
.
|
.
|
||||||
└─ assets/external/
|
└─ assets/external/
|
||||||
├─ unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
|
├─ unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
|
||||||
|
@ -45,7 +45,7 @@ By default, the built-in blog plugin assumes that your blog is hosted inside
|
|||||||
the `blog` subfolder of your documentation ([this is configurable]). Next,
|
the `blog` subfolder of your documentation ([this is configurable]). Next,
|
||||||
you need to create the following structure:
|
you need to create the following structure:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ blog/
|
│ └─ blog/
|
||||||
@ -935,7 +935,7 @@ your first post. The plugin doesn't assume any specific directory structure, so
|
|||||||
you're completely free in how you organize your posts, as long as they are all
|
you're completely free in how you organize your posts, as long as they are all
|
||||||
located inside the `posts` directory:
|
located inside the `posts` directory:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ blog/
|
│ └─ blog/
|
||||||
@ -1213,7 +1213,7 @@ for each post. Luckily, the [built-in meta plugin] allows to set default front
|
|||||||
matter properties per folder. You can group your posts by categories, or
|
matter properties per folder. You can group your posts by categories, or
|
||||||
authors, and add a `.meta.yml` file to set common properties:
|
authors, and add a `.meta.yml` file to set common properties:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ blog/
|
│ └─ blog/
|
||||||
@ -1278,7 +1278,7 @@ If you want to add custom content to automatically generated [archive] and
|
|||||||
posts, you can manually create the category page in the same location where
|
posts, you can manually create the category page in the same location where
|
||||||
the [built-in blog plugin] would create it:
|
the [built-in blog plugin] would create it:
|
||||||
|
|
||||||
``` sh
|
``` { .sh .no-copy }
|
||||||
.
|
.
|
||||||
├─ docs/
|
├─ docs/
|
||||||
│ └─ blog/
|
│ └─ blog/
|
||||||
|
Loading…
Reference in New Issue
Block a user