Pipe can not be used in a markdown table.

zendev1710 commented

2026-01-24 22:22:36 +01:00

(Migrated from github.com)

Hi,

I did not find how to use the alias form as a value in a markdown table cell.
markdown linters and extensions in EDI does not understand this.

Maybe another special character could be used as an alternative instead of pipe character ?

Hi, I did not find how to use the [[alias | text]] form as a value in a markdown table cell. markdown linters and extensions in EDI does not understand this. Maybe another special character could be used as an alternative instead of pipe character ?

EddyLuten commented

2026-01-24 22:32:33 +01:00

(Migrated from github.com)

Thanks for the bug report. I'll see if I can reproduce the issue and see if it's fixable.

EddyLuten commented

2026-01-24 22:50:27 +01:00

(Migrated from github.com)

Here's an ugly little table I used to test this with:

| One | Two | Three |
|-|-|-|
| 1 | [[index|Alt Text]] | 3 |
| 2 | 3 | 1 |
| 3 | 1 | 2 |

It seems to render okay for me:

Do you have a specific use case that doesn't work?

Here's an ugly little table I used to test this with: ```md | One | Two | Three | |-|-|-| | 1 | [[index|Alt Text]] | 3 | | 2 | 3 | 1 | | 3 | 1 | 2 | ``` It seems to render okay for me: <img width="436" height="283" alt="Image" src="https://github.com/user-attachments/assets/2bd8e734-05c0-4b8e-836b-54e81f42dae5" /> Do you have a specific use case that doesn't work?

zendev1710 commented

2026-01-24 23:01:01 +01:00

(Migrated from github.com)

Hello, as I said, inserting the alias with this format produces issues on third party tools : for instance, markdown lint and all markdown table related plugins in VS Code.

For a large mkdocs project, it's hard to maintain.

Hello, as I said, inserting the alias with this format produces issues on third party tools : for instance, markdown lint and all markdown table related plugins in VS Code. For a large mkdocs project, it's hard to maintain.

EddyLuten commented

2026-01-24 23:35:27 +01:00

(Migrated from github.com)

Gotcha, that makes sense. I am less inclined to add support for a new or multiple separators for this single use case to avoid breaking external programs. The Markdown syntax that this plugin provides is non-standard, so I quite expect every new feature added to it to break more standard Markdown formatting expectations.

One way to get around this is by using the footnote syntax for aliases in tables, which seems to be respected by the VSCode table formatting plugin since it doesn't use pipes:

| One | Two                      | Three |
| --- | ------------------------ | ----- |
| 1   | [Alt Text][alias-plugin] | 3     |
| 2   | 3                        | 1     |
| 3   | 1                        | 2     |

[alias-plugin]: https://github.com/EddyLuten/mkdocs-alias-plugin

Let me know if that's a suitable workaround for you. I'm okay leaving this bug open in case this becomes an issue for more users.

Gotcha, that makes sense. I am less inclined to add support for a new or multiple separators for this single use case to avoid breaking external programs. The Markdown syntax that this plugin provides is non-standard, so I quite expect every new feature added to it to break more standard Markdown formatting expectations. One way to get around this is by using the footnote syntax for aliases in tables, which seems to be respected by the VSCode table formatting plugin since it doesn't use pipes: ```md | One | Two | Three | | --- | ------------------------ | ----- | | 1 | [Alt Text][alias-plugin] | 3 | | 2 | 3 | 1 | | 3 | 1 | 2 | [alias-plugin]: https://github.com/EddyLuten/mkdocs-alias-plugin ``` Let me know if that's a suitable workaround for you. I'm okay leaving this bug open in case this becomes an issue for more users.

zendev1710 commented

2026-01-25 09:37:57 +01:00

(Migrated from github.com)

I though about this workaround, but unfortunately, my mkdocs project is a multi-language one using i18n, and there is this #25 issue.

in your example, I think you meant :

...  
[alias-plugin]: [[myalias]]

I though about this workaround, but unfortunately, my mkdocs project is a multi-language one using i18n, and there is this [#25 issue](#25). in your example, I think you meant : ```text ... [alias-plugin]: [[myalias]] ```

luten self-assigned this

2026-04-05 00:12:49 +02:00

luten removed their assignment

2026-04-05 00:12:55 +02:00

luten self-assigned this

2026-04-05 00:12:58 +02:00

luten added this to the MkDocs Plugins project

2026-04-05 02:01:57 +02:00

Rows
Columns

Pipe can not be used in a markdown table. #24