From b1ecde6a6c2caf0addd11983fe78f9fbfa3515fd Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 31 Dec 2022 15:02:02 +0100 Subject: [PATCH] Added no-copy classes for directory listings --- docs/blog/posts/blog-support-just-landed.md | 4 ++-- docs/creating-your-site.md | 2 +- docs/customization.md | 10 +++++----- docs/setup/changing-the-logo-and-icons.md | 2 +- docs/setup/ensuring-data-privacy.md | 2 +- docs/setup/setting-up-a-blog.md | 8 ++++---- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/blog/posts/blog-support-just-landed.md b/docs/blog/posts/blog-support-just-landed.md index 641d4a4fd..6b65a7048 100644 --- a/docs/blog/posts/blog-support-just-landed.md +++ b/docs/blog/posts/blog-support-just-landed.md @@ -64,7 +64,7 @@ mkdocs new . This will create the following structure: -``` +``` { .sh .no-copy } . ├─ docs/ │ └─ 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` with a file called `hello-world.md`: -``` sh +``` { .sh .no-copy } . ├─ docs/ │ ├─ posts/ diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index 4fc90ff28..8474ec543 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -24,7 +24,7 @@ Alternatively, if you're running Material for MkDocs from within Docker, use: This will create the following structure: -``` +``` { .sh .no-copy } . ├─ docs/ │ └─ index.md diff --git a/docs/customization.md b/docs/customization.md index 31c4aef49..720889dfa 100644 --- a/docs/customization.md +++ b/docs/customization.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 new style sheet file in the `docs` directory: -``` sh +``` { .sh .no-copy } . ├─ docs/ │ └─ stylesheets/ @@ -39,7 +39,7 @@ extra_css: 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: -``` sh +``` { .sh .no-copy } . ├─ docs/ │ └─ 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 assets may also be put in the `overrides` directory: -``` sh +``` { .sh .no-copy } . ├─ .icons/ # Bundled icon sets ├─ 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` directory: -``` sh +``` { .sh .no-copy } . ├─ overrides/ │ └─ 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 the `overrides` directory: -``` sh +``` { .sh .no-copy } . ├─ overrides/ │ └─ main.html diff --git a/docs/setup/changing-the-logo-and-icons.md b/docs/setup/changing-the-logo-and-icons.md index 1478fa488..c267fba00 100644 --- a/docs/setup/changing-the-logo-and-icons.md +++ b/docs/setup/changing-the-logo-and-icons.md @@ -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 your project documentation. The structure of your project should look like this: -``` sh +``` { .sh .no-copy } . ├─ overrides/ │ └─ .icons/ diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index c295940d6..b97cbddac 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -360,7 +360,7 @@ removed during the build process. For the official documentation, the [built-in privacy plugin] downloads the following resources: - ``` { .sh id="example" } + ``` { .sh .no-copy #example } . └─ assets/external/ ├─ unpkg.com/tablesort@5.3.0/dist/tablesort.min.js diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index e4291720c..ae4bd89df 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -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, you need to create the following structure: -``` sh +``` { .sh .no-copy } . ├─ docs/ │ └─ 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 located inside the `posts` directory: -``` sh +``` { .sh .no-copy } . ├─ docs/ │ └─ 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 authors, and add a `.meta.yml` file to set common properties: -``` sh +``` { .sh .no-copy } . ├─ docs/ │ └─ 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 the [built-in blog plugin] would create it: -``` sh +``` { .sh .no-copy } . ├─ docs/ │ └─ blog/