Skip to content

Commit

Permalink
Remove link targets (#116)
Browse files Browse the repository at this point in the history
* bump to 3.10.2

* remove target='_blank'

* add missing commas

* remove _blank target from footer and revision blocks

* update tests

* remove link_target from example in documentation since it is not recommended
  • Loading branch information
ntno authored Jan 31, 2023
1 parent 4707c6f commit 0f37dc5
Show file tree
Hide file tree
Showing 28 changed files with 85 additions and 91 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/configuration/blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In some situations you may want to include your own Jinja2 page templates. Terminal for MkDocs supports overriding or extending the blocks listed in [Reference](blocks.md#overridable-blocks).

This is an advanced MkDocs feature. For an extended discussion, see the [official MkDocs guide]{target="_blank"}.
This is an advanced MkDocs feature. For an extended discussion, see the [official MkDocs guide].


[official MkDocs guide]: https://www.mkdocs.org/user-guide/customizing-your-theme/#using-the-theme-custom_dir
Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/configuration/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ configuration/extensions/links.md
# Extensions

Markdown is a very small language with a kind-of reference implementation called
[John Gruber's Markdown]{target="_blank"}. [Python Markdown]{target="_blank"} and [PyMdown Extensions]{target="_blank"} are two packages that enhance the Markdown writing experience, adding useful syntax extensions for technical writing.
[John Gruber's Markdown]. [Python Markdown] and [PyMdown Extensions] are two packages that enhance the Markdown writing experience, adding useful syntax extensions for technical writing.

[John Gruber's Markdown]: https://daringfireball.net/projects/markdown/
[Python Markdown]: https://python-markdown.github.io/extensions/
Expand Down Expand Up @@ -106,4 +106,4 @@ markdown_extensions:
```
# Credit
This documentation page is based on squidfunk's Material for MkDocs [Extensions](https://squidfunk.github.io/mkdocs-material/setup/extensions/){target="_blank"} documentation.
This documentation page is based on squidfunk's Material for MkDocs [Extensions](https://squidfunk.github.io/mkdocs-material/setup/extensions/) documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ configuration/extensions/links.md

# PyMdown Extensions

The [PyMdown Extensions]{target="_blank"} package is an excellent collection of
The [PyMdown Extensions] package is an excellent collection of
additional extensions perfectly suited for advanced technical writing. Terminal
for MkDocs lists this package as an explicit dependency so it's automatically
installed with a supported version.
Expand All @@ -15,7 +15,7 @@ installed with a supported version.

## Caret, Mark & Tilde

The [Caret]{target="_blank"}, [Mark]{target="_blank"} and [Tilde]{target="_blank"} extensions add the ability to highlight text
The [Caret], [Mark], and [Tilde] extensions add the ability to highlight text
and define subscript and superscript using a simple syntax. Enable them together
via `mkdocs.yml`:

Expand Down Expand Up @@ -47,7 +47,7 @@ See reference for usage:
## Snippets
The [Snippets]{target="_blank"} extension adds the ability to embed content from arbitrary files into a document, including other documents or source files, by using a simple syntax. Enable it via `mkdocs.yml`:
The [Snippets] extension adds the ability to embed content from arbitrary files into a document, including other documents or source files, by using a simple syntax. Enable it via `mkdocs.yml`:

``` yaml
markdown_extensions:
Expand All @@ -56,7 +56,7 @@ markdown_extensions:

The configuration options of this extension are not specific to Terminal for
MkDocs, as they only impact the Markdown parsing stage. See the [Snippets
documentation][Snippets]{target="_blank"} for more information.
documentation][Snippets] for more information.

[Snippets]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

Expand All @@ -69,4 +69,4 @@ See reference for usage:

# Credit

This documentation page is based on squidfunk's Material for MkDocs [Pymdown Extension](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/){target="_blank"} documentation.
This documentation page is based on squidfunk's Material for MkDocs [Pymdown Extension](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/) documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ configuration/extensions/links.md

# PyMdown Extensions

The [PyMdown Extensions]{target="_blank"} package is an excellent collection of
The [PyMdown Extensions] package is an excellent collection of
additional extensions perfectly suited for advanced technical writing. Terminal
for MkDocs lists this package as an explicit dependency so it's automatically
installed with a supported version.
Expand All @@ -15,7 +15,7 @@ installed with a supported version.

## Caret, Mark & Tilde

The [Caret]{target="_blank"}, [Mark]{target="_blank"} and [Tilde]{target="_blank"} extensions add the ability to highlight text
The [Caret], [Mark], and [Tilde] extensions add the ability to highlight text
and define subscript and superscript using a simple syntax. Enable them together
via `mkdocs.yml`:

Expand Down Expand Up @@ -47,7 +47,7 @@ See reference for usage:
## Snippets
The [Snippets]{target="_blank"} extension adds the ability to embed content from arbitrary files into a document, including other documents or source files, by using a simple syntax. Enable it via `mkdocs.yml`:
The [Snippets] extension adds the ability to embed content from arbitrary files into a document, including other documents or source files, by using a simple syntax. Enable it via `mkdocs.yml`:

``` yaml
markdown_extensions:
Expand All @@ -56,7 +56,7 @@ markdown_extensions:

The configuration options of this extension are not specific to Terminal for
MkDocs, as they only impact the Markdown parsing stage. See the [Snippets
documentation][Snippets]{target="_blank"} for more information.
documentation][Snippets] for more information.

[Snippets]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

Expand All @@ -69,4 +69,4 @@ See reference for usage:

# Credit

This documentation page is based on squidfunk's Material for MkDocs [Pymdown Extension](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/){target="_blank"} documentation.
This documentation page is based on squidfunk's Material for MkDocs [Pymdown Extension](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/) documentation.
20 changes: 10 additions & 10 deletions documentation/docs/configuration/extensions/python-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ configuration/extensions/links.md

# Python Markdown

Terminal for MkDocs is compatible with some of the [Python Markdown]{target="_blank"} extensions. The following is a list of all extensions which have been tested with this theme, linking to documentation which explain how they can be used.
Terminal for MkDocs is compatible with some of the [Python Markdown] extensions. The following is a list of all extensions which have been tested with this theme, linking to documentation which explain how they can be used.

[Python Markdown]: https://python-markdown.github.io/extensions/

# Suggested Python Markdown Extensions

## Attribute Lists

The [Attribute Lists]{target="_blank"} extension helps to add HTML attributes and CSS classes to [almost every][Attribute Lists limitations]{target="_blank"} Markdown inline- and block-level element with a special syntax. Enable it via `mkdocs.yml`:
The [Attribute Lists] extension helps to add HTML attributes and CSS classes to [almost every][Attribute Lists limitations] Markdown inline- and block-level element with a special syntax. Enable it via `mkdocs.yml`:

``` yaml
markdown_extensions:
Expand All @@ -33,8 +33,8 @@ No configuration options are available. See reference for usage:
## Definition Lists
The [Definition Lists]{target="_blank"} extension adds the ability to add definition lists (more
commonly known as [description lists]{target="_blank"}`dl` in HTML) via Markdown to a
The [Definition Lists] extension adds the ability to add definition lists (more
commonly known as [description lists] – `dl` in HTML) via Markdown to a
document. Enable it via `mkdocs.yml`:

``` yaml
Expand All @@ -52,7 +52,7 @@ No configuration options are available. See reference for usage:

## Footnotes

The [Footnotes]{target="_blank"} extension enables inline footnotes which are then
The [Footnotes] extension enables inline footnotes which are then
rendered below all Markdown content of a document. Enable it via `mkdocs.yml`:

``` yaml
Expand All @@ -71,15 +71,15 @@ No configuration options are supported. See reference for usage:

## Markdown in HTML

The [Markdown in HTML]{target="_blank"} extension allows for writing Markdown inside of HTML, which is useful for wrapping Markdown content with custom elements. Enable it
The [Markdown in HTML] extension allows for writing Markdown inside of HTML, which is useful for wrapping Markdown content with custom elements. Enable it
via `mkdocs.yml`:

``` yaml
markdown_extensions:
- md_in_html
```

From the [Markdown in HTML]{target="_blank"} extension's docs:
From the [Markdown in HTML] extension's docs:
> By default, Markdown ignores any content within a raw HTML block-level element. With the `md_in_html` extension enabled, the content of a raw HTML block-level element can be parsed as Markdown by including a `markdown` attribute on the opening tag. The `markdown` attribute will be stripped from the output, while all other attributes will be preserved.


Expand All @@ -95,7 +95,7 @@ No configuration options are available. See reference for usage:

## Table of Contents

The [Table of Contents]{target="_blank"} extension automatically generates a table of contents from a document which Terminal for MkDocs will render as part of the resulting page. It can be configured via `mkdocs.yml`:
The [Table of Contents] extension automatically generates a table of contents from a document which Terminal for MkDocs will render as part of the resulting page. It can be configured via `mkdocs.yml`:

``` yaml
markdown_extensions:
Expand Down Expand Up @@ -151,7 +151,7 @@ See reference for usage:

## Tables

The [Tables]{target="_blank"} extension adds the ability to create tables in Markdown by using a simple syntax. Enable it via `mkdocs.yml` (albeit it should be enabled by
The [Tables] extension adds the ability to create tables in Markdown by using a simple syntax. Enable it via `mkdocs.yml` (albeit it should be enabled by
default):

``` yaml
Expand All @@ -170,5 +170,5 @@ No configuration options are available. See reference for usage:

# Credit

This documentation page is based on squidfunk's Material for MkDocs [Python Markdown](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/){target="_blank"} documentation.
This documentation page is based on squidfunk's Material for MkDocs [Python Markdown](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/) documentation.

2 changes: 1 addition & 1 deletion documentation/docs/configuration/extensions/snippets.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ markdown_extensions:
- docs
```
See the [Snippets documentation][Snippets]{target="_blank"} for more information on configuration options.
See the [Snippets documentation][Snippets] for more information on configuration options.
[Snippets]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/configuration/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ enables the "Page last updated..." text at the bottom of the page. requires [gi
enables the "See revision history..." text at the bottom of the page. requires [git-revision-date plugin setup] and additional [git-revision-date configuration].

## style.links.underline.hide
hides the underline styling on links. the underline text decoration on links is added to make the links identifiable without color vision. if you choose to hide this styling you should consider adding an alternate [non-color link indicator]{target="_blank"}.
hides the underline styling on links. the underline text decoration on links is added to make the links identifiable without color vision. if you choose to hide this styling you should consider adding an alternate [non-color link indicator].

[git-revision-date plugin setup]: ../plugins/git-revision/
[git-revision-date configuration]: ../plugins/git-revision/#advanced-configuration
Expand All @@ -56,7 +56,7 @@ hides the underline styling on links. the underline text decoration on links is

# Page Features

To hide certain [Terminal for MkDocs components] on a per-page basis, add a [YAML Style Meta-Data]{target="_blank"} section to the very top of your Markdown page. Inside this metadata section, add the attribute `hide` which is a list of page-specific feature names.
To hide certain [Terminal for MkDocs components] on a per-page basis, add a [YAML Style Meta-Data] section to the very top of your Markdown page. Inside this metadata section, add the attribute `hide` which is a list of page-specific feature names.

Pay special attention to the indentation. There should be two spaces before the `-` marking the start of a component name:

Expand Down
8 changes: 4 additions & 4 deletions documentation/docs/configuration/plugins/git-revision.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Git Revision Date Plugin
The third-party [git-revision-date]{target="_blank"} plugin automatically adds the last revision date of a markdown page to its MkDocs Page Metadata[^mkdocs-page-meta].
The third-party [git-revision-date] plugin automatically adds the last revision date of a markdown page to its MkDocs Page Metadata[^mkdocs-page-meta].

[git-revision-date]: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin
[MkDocs Page Metadata]: https://www.mkdocs.org/user-guide/writing-your-docs/#meta-data
[^mkdocs-page-meta]: see [MkDocs Page Metadata]{target="_blank"} for more info
[^mkdocs-page-meta]: see [MkDocs Page Metadata] for more info

# Built-in Support
When the `git-revision-date` plugin is installed and enabled and the `revision.date` theme feature is enabled, Terminal for MkDocs will display the date of the most recent change to a page's source file on the rendered site page. This component is added at the bottom of each page unless [page-specific hiding] is enabled.
Expand Down Expand Up @@ -54,7 +54,7 @@ theme:
# Advanced Configuration
There are two revision-related theme features that can be individually enabled. The example above only discusses `revision.date` as it is easier to configure without error.

The second revision-related theme feature is `revision.history`. Enabling this theme feature will add a "See revision history..." note to the bottom of the page. The link included in this note relies on MkDocs' [repo_url]{target="_blank"}, [repo_name]{target="_blank"}, and [edit_uri]{target="_blank"}/[edit_uri_template]{target="_blank"} settings.
The second revision-related theme feature is `revision.history`. Enabling this theme feature will add a "See revision history..." note to the bottom of the page. The link included in this note relies on MkDocs' [repo_url], [repo_name], and [edit_uri]/[edit_uri_template] settings.

[repo_url]: https://www.mkdocs.org/user-guide/configuration/#repo_url
[repo_name]: https://www.mkdocs.org/user-guide/configuration/#repo_name
Expand Down Expand Up @@ -125,7 +125,7 @@ theme:


## Adding Repository Hosts
If your repository is not stored on GitHub or Bitbucket and you would like to use this feature please [submit a feature request]{target="_blank"} on GitHub.
If your repository is not stored on GitHub or Bitbucket and you would like to use this feature please [submit a feature request] on GitHub.

You can further customize what revision information is included on the page by implementing your own `revision` template block. See [Blocks] for more information.

Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/configuration/plugins/macros.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MkDocs Macros Plugin

The third-party [macros]{target="_blank"} plugin transforms markdown pages into [jinja2]{target="_blank"} templates. This allows you to create complex and feature-rich pages using variables, calls to custom functions, and filters.
The third-party [macros] plugin transforms markdown pages into [jinja2] templates. This allows you to create complex and feature-rich pages using variables, calls to custom functions, and filters.

You can write and publish your own functions to use in your markdown pages. These functions are called macros. You can also install macros written by others via pip. Once a macro has been installed, it must be enabled in your MkDocs config before you can use it.

Expand Down Expand Up @@ -50,6 +50,6 @@ A table with entries describing the MkDocs configuration for your site should be

## 4. Configuration

See [MkDocs Macros Plugin]{target="_blank"} documentation for configuration options.
See [MkDocs Macros Plugin] documentation for configuration options.

[MkDocs Macros Plugin]: https://mkdocs-macros-plugin.readthedocs.io/en/latest/#configuration-of-the-plugin
2 changes: 1 addition & 1 deletion documentation/docs/configuration/plugins/search.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Search Plugin
MkDocs comes with a built-in and automatically enabled [search plugin]{target="_blank"}.
MkDocs comes with a built-in and automatically enabled [search plugin].

[search plugin]: https://www.mkdocs.org/user-guide/configuration/#search

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/elements/examples/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

[Documentation Home Page](/)

[GitHub Repository](https://github.com/ntno/mkdocs-terminal){target="_blank"}
[GitHub Repository](https://github.com/ntno/mkdocs-terminal)

<br>
4 changes: 2 additions & 2 deletions documentation/docs/elements/examples/table.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

| Release | Supported? |
| :-----: | :---------: |
| [1.0.0]{target="_blank"} | yes |
| [0.0.0]{target="_blank"} | no |
| [1.0.0] | yes |
| [0.0.0] | no |

[1.0.0]: https://github.com/ntno/mkdocs-terminal/releases/tag/1.0.0
[0.0.0]: https://github.com/ntno/mkdocs-terminal/releases/tag/0.0.0
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/elements/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) in
```

# Credit
Examples and instructional text in this document were adapted from the [basic syntax markdown guide]{target="_blank"} on [markdownguide.org]{target="_blank"}.
Examples and instructional text in this document were adapted from the [basic syntax markdown guide] on [markdownguide.org].

[basic syntax markdown guide]: https://www.markdownguide.org/basic-syntax/#lists-1
[markdownguide.org]: https://www.markdownguide.org
8 changes: 4 additions & 4 deletions documentation/docs/elements/table.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Note: this example requires the [attr_list extension] be enabled.

| Release | Supported? |
| :-----: | :---------: |
| [1.0.0]{target="_blank"} | yes |
| [0.0.0]{target="_blank"} | no |
| [1.0.0] | yes |
| [0.0.0] | no |

[1.0.0]: https://github.com/ntno/mkdocs-terminal/releases/tag/1.0.0
[0.0.0]: https://github.com/ntno/mkdocs-terminal/releases/tag/0.0.0
Expand All @@ -45,8 +45,8 @@ Note: this example requires the [attr_list extension] be enabled.
```markdown
| Release | Supported? |
| :-----: | :---------: |
| [1.0.0]{target="_blank"} | yes |
| [0.0.0]{target="_blank"} | no |
| [1.0.0] | yes |
| [0.0.0] | no |

[1.0.0]: https://github.com/ntno/mkdocs-terminal/releases/tag/1.0.0
[0.0.0]: https://github.com/ntno/mkdocs-terminal/releases/tag/0.0.0
Expand Down
10 changes: 5 additions & 5 deletions documentation/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ hide:
---

# mkdocs-terminal
Terminal for MkDocs is a third party theme that brings the [Terminal.css](https://github.com/Gioni06/terminal.css){target="_blank"} stylesheet to MkDocs documentation sites.
Terminal for MkDocs is a third party theme that brings the [Terminal.css](https://github.com/Gioni06/terminal.css) stylesheet to MkDocs documentation sites.

In addition to simple, monospace styling, Terminal for MkDocs also provides:

Expand All @@ -18,10 +18,10 @@ In addition to simple, monospace styling, Terminal for MkDocs also provides:
- and more

## Developer Info
[Terminal for MkDocs on GitHub](https://github.com/ntno/mkdocs-terminal){target="_blank"}
[Terminal for MkDocs on PyPI](https://pypi.org/project/mkdocs-terminal/){target="_blank"}
[Terminal for MkDocs Documentation](https://ntno.github.io/mkdocs-terminal/){target="_blank"}
[MkDocs Documentation](https://www.mkdocs.org/){target="_blank"}
[Terminal for MkDocs on GitHub](https://github.com/ntno/mkdocs-terminal)
[Terminal for MkDocs on PyPI](https://pypi.org/project/mkdocs-terminal/)
[Terminal for MkDocs Documentation](https://ntno.github.io/mkdocs-terminal/)
[MkDocs Documentation](https://www.mkdocs.org/)


### License
Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/install.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Installation

## 1. Setup MkDocs project
See [Getting Started](https://www.mkdocs.org/getting-started/){target="_blank"} for details.
See [Getting Started](https://www.mkdocs.org/getting-started/) for details.

## 2. Install Theme
Install the [mkdocs-terminal pip package](https://pypi.org/project/mkdocs-terminal/){target="_blank"}. Add the package to your `requirements.txt` file:
Install the [mkdocs-terminal pip package](https://pypi.org/project/mkdocs-terminal/). Add the package to your `requirements.txt` file:

```text
mkdocs
Expand Down
Loading

0 comments on commit 0f37dc5

Please sign in to comment.