# \#markdown

**URL:** https://forum.gitlab.com/tag/markdown/123.md

[Latest](https://forum.gitlab.com/latest.md) · [Categories](https://forum.gitlab.com/categories.md) · [Tags](https://forum.gitlab.com/tags.md)

---

## [SVG background in README.md](https://forum.gitlab.com/t/svg-background-in-readme-md/133434)

<div class="topic-metadata">

**Author:** [@mirabilos](https://forum.gitlab.com/u/mirabilos)\
**Replies:** 0\
**Last updated:** [April 9, 2026, 6:38am UTC](https://forum.gitlab.com/t/svg-background-in-readme-md/133434 "2026-04-09T06:38:41Z")

</div>

Problem to solve When adding an SVG to README.md via the usual image syntax, the background is transparent, not white, which makes the text illegible with a dark theme. I do have the SVG background set to white in Inksc…

---

## [How to use GitLab Flavored Markdown's ::include](https://forum.gitlab.com/t/how-to-use-gitlab-flavored-markdowns-include/131582)

<div class="topic-metadata">

**Author:** [@huanghaiqing1](https://forum.gitlab.com/u/huanghaiqing1)\
**Replies:** 0\
**Last updated:** [November 26, 2025, 1:08am UTC](https://forum.gitlab.com/t/how-to-use-gitlab-flavored-markdowns-include/131582 "2025-11-26T01:08:57Z")

</div>

Here our gitlab self-managed version is: GitLab Community Edition \[v17.5.5\] and we just can’t use GitLab Flavored Markdown’s ::includ module in our markdown file by KB: GitLab Flavored Markdown (GLFM) | GitLab Docs The …

---

## [In README on project homepage, links to anchors don't land on the anchor](https://forum.gitlab.com/t/in-readme-on-project-homepage-links-to-anchors-dont-land-on-the-anchor/131412)

<div class="topic-metadata">

**Author:** [@seb-maillard](https://forum.gitlab.com/u/seb-maillard)\
**Replies:** 3\
**Last updated:** [November 13, 2025, 9:11pm UTC](https://forum.gitlab.com/t/in-readme-on-project-homepage-links-to-anchors-dont-land-on-the-anchor/131412 "2025-11-13T21:11:36Z")

</div>

Hey there! I have a rather long README file for my One-Pager Chords project (still work in progress, both the README and the project) and I’ve been experiencing issues with links to anchors. But only when viewing the RE…

---

## [Using url-link in mermaid node description](https://forum.gitlab.com/t/using-url-link-in-mermaid-node-description/29855)

<div class="topic-metadata">

**Author:** [@piflixe](https://forum.gitlab.com/u/piflixe)\
**Replies:** 3\
**Last updated:** [June 3, 2025, 12:51pm UTC](https://forum.gitlab.com/t/using-url-link-in-mermaid-node-description/29855 "2025-06-03T12:51:13Z")

</div>

I really love the mermaid graphs included in the gitlab markup! We would like to add links to our graphs to link to issues, milestones, wiki pages, external pages etc. I found several ways to do this, eg using href oder…

---

## [Include directive inside code block](https://forum.gitlab.com/t/include-directive-inside-code-block/120051)

<div class="topic-metadata">

**Author:** [@aragagnin](https://forum.gitlab.com/u/aragagnin)\
**Replies:** 0\
**Last updated:** [January 19, 2025, 2:28pm UTC](https://forum.gitlab.com/t/include-directive-inside-code-block/120051 "2025-01-19T14:28:19Z")

</div>

First of all, I want to say how happy I am that GitLab has implemented the include directive! My specific goal is to use this directive to include code files in the README, so that is contains tested snippets. I am cur…

---

## [Mermaid Diagram isn't working](https://forum.gitlab.com/t/mermaid-diagram-isnt-working/113616)

<div class="topic-metadata">

**Author:** [@kepboy](https://forum.gitlab.com/u/kepboy)\
**Replies:** 6\
**Last updated:** [October 28, 2024, 3:12pm UTC](https://forum.gitlab.com/t/mermaid-diagram-isnt-working/113616 "2024-10-28T15:12:41Z")

</div>

I have a mermaid diagram defined in my project’s README. Source is below graph TB subgraph sg\_sf\["SpecFlow"\]; sg\_sf\_dn("PlayNicely.SpecFlow.DotNet") --\> sg\_sf\_exe("PlayNicely.SpecFlow.Executor") end …

---

## [Colorizing text in README.md in Gitlab or provide colorized chit without syntax](https://forum.gitlab.com/t/colorizing-text-in-readme-md-in-gitlab-or-provide-colorized-chit-without-syntax/38590)

<div class="topic-metadata">

**Author:** [@warronf](https://forum.gitlab.com/u/warronf)\
**Replies:** 7\
**Last updated:** [October 22, 2024, 4:43pm UTC](https://forum.gitlab.com/t/colorizing-text-in-readme-md-in-gitlab-or-provide-colorized-chit-without-syntax/38590 "2024-10-22T16:43:02Z")

</div>

I am running gitlab-ce-12.10.6 self-managed on a CentOS 7.8 server. I have finally started uploading projects, creating Wikis, and etcetera. I would like to be able to set the color of text in my Wiki pages written in …

---

## [Gitlab Handbook misinforms about Markdown?](https://forum.gitlab.com/t/gitlab-handbook-misinforms-about-markdown/111372)

<div class="topic-metadata">

**Author:** [@aneganov](https://forum.gitlab.com/u/aneganov)\
**Replies:** 0\
**Last updated:** [September 11, 2024, 12:31pm UTC](https://forum.gitlab.com/t/gitlab-handbook-misinforms-about-markdown/111372 "2024-09-11T12:31:37Z")

</div>

From here: Handbook Markdown Guide | The GitLab Handbook Like one can use {#new-id} to add the id attr to the title. But it simply doesn’t work. Instead of staying invisible, like the article predicts, they get rend…

---

## [Mermaid: link node to another markdown file](https://forum.gitlab.com/t/mermaid-link-node-to-another-markdown-file/94980)

<div class="topic-metadata">

**Author:** [@baby-gnu](https://forum.gitlab.com/u/baby-gnu)\
**Replies:** 0\
**Last updated:** [November 6, 2023, 3:12pm UTC](https://forum.gitlab.com/t/mermaid-link-node-to-another-markdown-file/94980 "2023-11-06T15:12:23Z")

</div>

Make a node a clickable link to another markdown file In mermaid, it’s possible to make a node a link but I find no way to point to another file of the repository. My use case is to describe a project with a schema and …

---

## [How to embed asciinema player in GitLab Flavored Markdown?](https://forum.gitlab.com/t/how-to-embed-asciinema-player-in-gitlab-flavored-markdown/90769)

<div class="topic-metadata">

**Author:** [@millermatt](https://forum.gitlab.com/u/millermatt)\
**Replies:** 1\
**Last updated:** [August 2, 2023, 9:02pm UTC](https://forum.gitlab.com/t/how-to-embed-asciinema-player-in-gitlab-flavored-markdown/90769 "2023-08-02T21:02:53Z")

</div>

Is there a way to embed the asciinema player in a GitLab Flavored Markdown file? I can embed a screenshot that opens a new tab to the recording on asciinema.org, but I can’t figure out how be able to play the recording …

---

## [Relative-directory links in the Markdown file are copied incorrectly in a case](https://forum.gitlab.com/t/relative-directory-links-in-the-markdown-file-are-copied-incorrectly-in-a-case/84883)

<div class="topic-metadata">

**Author:** [@c4c](https://forum.gitlab.com/u/c4c)\
**Replies:** 0\
**Last updated:** [April 14, 2023, 2:56am UTC](https://forum.gitlab.com/t/relative-directory-links-in-the-markdown-file-are-copied-incorrectly-in-a-case/84883 "2023-04-14T02:56:50Z")

</div>

Describe your question in as much detail as possible: This file on gitlab.com has the following markdown code: - \[About\](./about.md) It is a relative-directory link. How to reproduce this problem: Access the rend…

---

## [Markdown list is not rendered correctly](https://forum.gitlab.com/t/markdown-list-is-not-rendered-correctly/84881)

<div class="topic-metadata">

**Author:** [@c4c](https://forum.gitlab.com/u/c4c)\
**Replies:** 1\
**Last updated:** [April 14, 2023, 1:59am UTC](https://forum.gitlab.com/t/markdown-list-is-not-rendered-correctly/84881 "2023-04-14T01:59:46Z")

</div>

Describe your question in as much detail as possible: In this file on gitlab.com, the following markdown list is not rendered correctly - \[Index & Index2\](./index.md)(译注：待完善) - \[AH 1500万部突破記念「Memory of X・Y・Z」（20…

---

## [Args Table in Markdown](https://forum.gitlab.com/t/args-table-in-markdown/35145)

<div class="topic-metadata">

**Author:** [@hmajid2301](https://forum.gitlab.com/u/hmajid2301)\
**Replies:** 1\
**Last updated:** [October 8, 2022, 7:00pm UTC](https://forum.gitlab.com/t/args-table-in-markdown/35145 "2022-10-08T19:00:33Z")

</div>

Args Table in Markdown I have a Python project with a README.rst it’s a CLI tool the README has a tidy little args table. It can be found here Usage ----- .. code-block:: bash pip install markdown-mermaid-to-images …

---

## [GitLab Flavored Markdown: Images and Text Wrapping](https://forum.gitlab.com/t/gitlab-flavored-markdown-images-and-text-wrapping/76039)

<div class="topic-metadata">

**Author:** [@jimvzit](https://forum.gitlab.com/u/jimvzit)\
**Replies:** 0\
**Last updated:** [October 8, 2022, 7:22pm UTC](https://forum.gitlab.com/t/gitlab-flavored-markdown-images-and-text-wrapping/76039 "2022-10-08T19:22:18Z")

</div>

How to have text to the left and an image to the right I’m looking to do something like this with gitlab flavored markdown, but can’t seem to pull it off: I’m able to get something similar using html table tags and i…

---

## [Rendering GitLab Flavoured Markdown (with LaTeX Math) into HTML](https://forum.gitlab.com/t/rendering-gitlab-flavoured-markdown-with-latex-math-into-html/33210)

<div class="topic-metadata">

**Author:** [@fchorney](https://forum.gitlab.com/u/fchorney)\
**Replies:** 1\
**Last updated:** [July 26, 2022, 8:50am UTC](https://forum.gitlab.com/t/rendering-gitlab-flavoured-markdown-with-latex-math-into-html/33210 "2022-07-26T08:50:51Z")

</div>

Hi, so I’m having an issue here with the GitLab Flavoured Markdown, and the LaTeX Math. We have some documentation .md files in a project that contain a good amount of Math in them. Now, this gets rendered when you see …

---

## [Prevent hyperlink for generated badges in markdown](https://forum.gitlab.com/t/prevent-hyperlink-for-generated-badges-in-markdown/67781)

<div class="topic-metadata">

**Author:** [@nsty](https://forum.gitlab.com/u/nsty)\
**Replies:** 2\
**Last updated:** [April 11, 2022, 4:57pm UTC](https://forum.gitlab.com/t/prevent-hyperlink-for-generated-badges-in-markdown/67781 "2022-04-11T16:57:47Z")

</div>

I’m generating badges for my readme file and some other external status pages in one of my pipelines. The amount of badges is only calculated at pipeline run-time and I don’t want to update the readme file every run. My …

---

## [Problem opening a new browser tab through mermaid model](https://forum.gitlab.com/t/problem-opening-a-new-browser-tab-through-mermaid-model/67477)

<div class="topic-metadata">

**Author:** [@n.beijebacht](https://forum.gitlab.com/u/n.beijebacht)\
**Replies:** 0\
**Last updated:** [March 29, 2022, 2:17pm UTC](https://forum.gitlab.com/t/problem-opening-a-new-browser-tab-through-mermaid-model/67477 "2022-03-29T14:17:26Z")

</div>

Hello, I’m trying to use my architecture model made in markdown with mermaid to redirect to the correlated GitLab pages. However I run into the issue that once a new browser tab is opened the local storage isn’t loaded p…

---

## [How to change 'checkbox' markdown to enabled?](https://forum.gitlab.com/t/how-to-change-checkbox-markdown-to-enabled/56255)

<div class="topic-metadata">

**Author:** [@camelek](https://forum.gitlab.com/u/camelek)\
**Replies:** 0\
**Last updated:** [July 27, 2021, 1:12pm UTC](https://forum.gitlab.com/t/how-to-change-checkbox-markdown-to-enabled/56255 "2021-07-27T13:12:26Z")

</div>

Default checkbox render is disabled I’m using in my organisation gitlab-ce and for many projects I’m writing something like “checklist” - procedure with every step user should take while he is performing some installatio…

---

## [Gitlab markdown issue for Wiki - direct page link](https://forum.gitlab.com/t/gitlab-markdown-issue-for-wiki-direct-page-link/56049)

<div class="topic-metadata">

**Author:** [@YJorge](https://forum.gitlab.com/u/YJorge)\
**Replies:** 0\
**Last updated:** [July 22, 2021, 9:44am UTC](https://forum.gitlab.com/t/gitlab-markdown-issue-for-wiki-direct-page-link/56049 "2021-07-22T09:44:02Z")

</div>

I have a link with a dollar sign. When I use a direct page link, dollar sign transforms to %24, and a link doesn’t work. It’s not my own address and I can’t change it. Using \\ before $ doesn’t help. \[example\](ex$ample.c…

---

## [Create Issue using API, description field markdown](https://forum.gitlab.com/t/create-issue-using-api-description-field-markdown/52846)

<div class="topic-metadata">

**Author:** [@ubergoonz](https://forum.gitlab.com/u/ubergoonz)\
**Replies:** 0\
**Last updated:** [May 10, 2021, 3:12pm UTC](https://forum.gitlab.com/t/create-issue-using-api-description-field-markdown/52846 "2021-05-10T15:12:20Z")

</div>

I am trying to make use of the GitLab API to create issue. In the description, I am trying to include more contents using markdown. Anyone have done this before and care to share more details?

---

## [Markdown blank lines in indents ... argh!](https://forum.gitlab.com/t/markdown-blank-lines-in-indents-argh/25796)

<div class="topic-metadata">

**Author:** [@sburkett](https://forum.gitlab.com/u/sburkett)\
**Replies:** 7\
**Last updated:** [March 28, 2021, 6:29pm UTC](https://forum.gitlab.com/t/markdown-blank-lines-in-indents-argh/25796 "2021-03-28T18:29:01Z")

</div>

OMG, I’m pulling my hair out on this silly little issue. I’m sure the answer is right in front of me, but I can’t see the forest for the trees right now on this thing! Thanks in advance for helping me “see the light” on …

---

## [How to escape Markdown automatic "special references"?](https://forum.gitlab.com/t/how-to-escape-markdown-automatic-special-references/26903)

<div class="topic-metadata">

**Author:** [@mc5686](https://forum.gitlab.com/u/mc5686)\
**Replies:** 3\
**Last updated:** [January 21, 2021, 6:30pm UTC](https://forum.gitlab.com/t/how-to-escape-markdown-automatic-special-references/26903 "2021-01-21T18:30:53Z")

</div>

I need to include “@stress” (a keyword for me) in README.md, but it gets automatically converted to point to user “Stress” (whoever he is). I tried escaping with “\\@stress”, but it doesn’t seem to make a difference. Wh…

---

## [Markdown Wiki links to other pages/files stop working on Upgrade to 13.0.3](https://forum.gitlab.com/t/markdown-wiki-links-to-other-pages-files-stop-working-on-upgrade-to-13-0-3/38312)

<div class="topic-metadata">

**Author:** [@acombo](https://forum.gitlab.com/u/acombo)\
**Replies:** 1\
**Last updated:** [June 5, 2020, 8:09pm UTC](https://forum.gitlab.com/t/markdown-wiki-links-to-other-pages-files-stop-working-on-upgrade-to-13-0-3/38312 "2020-06-05T20:09:17Z")

</div>

Summary I have upgraded today my gitlab-ce to Version 13.0.3 (In Ubuntu 18.04 - 64-bit). All of my markdown wiki links that do not use full url now fail with error 404. Note that NO other changes (other than the update)…

---

## [Is it possible to number headers in Gitlab wiki with markdown?](https://forum.gitlab.com/t/is-it-possible-to-number-headers-in-gitlab-wiki-with-markdown/37424)

<div class="topic-metadata">

**Author:** [@EganSolo](https://forum.gitlab.com/u/EganSolo)\
**Replies:** 1\
**Last updated:** [May 21, 2020, 2:40pm UTC](https://forum.gitlab.com/t/is-it-possible-to-number-headers-in-gitlab-wiki-with-markdown/37424 "2020-05-21T14:40:36Z")

</div>

Is it possible to number headers in GitLab wiki pages? Is it possible to generate automatic numbering of the headings in a wiki page, with the ability to specify the top number? Something like this: {{start-number-\>2}} …

---

## [How to create imagemap in gitlab markdown file](https://forum.gitlab.com/t/how-to-create-imagemap-in-gitlab-markdown-file/37225)

<div class="topic-metadata">

**Author:** [@st.loomans](https://forum.gitlab.com/u/st.loomans)\
**Replies:** 0\
**Last updated:** [May 5, 2020, 1:45pm UTC](https://forum.gitlab.com/t/how-to-create-imagemap-in-gitlab-markdown-file/37225 "2020-05-05T13:45:58Z")

</div>

Desired result a clickable image in a markdown-file on the gitlab platform. example in html : https://jsfiddle.net/abvjgwhy/ Attempt 1 : SVG - Built in links - with markdown code it is possible to implement urls in a…

---

## [Markdown API from file](https://forum.gitlab.com/t/markdown-api-from-file/35171)

<div class="topic-metadata">

**Author:** [@murashovaleksander](https://forum.gitlab.com/u/murashovaleksander)\
**Replies:** 0\
**Last updated:** [March 11, 2020, 8:11am UTC](https://forum.gitlab.com/t/markdown-api-from-file/35171 "2020-03-11T08:11:26Z")

</div>

How use markdown API from file? I want to use markdown API for render markdown to html from file (In file only markdown content (not json)). I see possibility use only text in query parameter or body. GitLab Version: …

---

## [Can I get the Markdown CSS files for render?](https://forum.gitlab.com/t/can-i-get-the-markdown-css-files-for-render/29239)

<div class="topic-metadata">

**Author:** [@mh48774877](https://forum.gitlab.com/u/mh48774877)\
**Replies:** 2\
**Last updated:** [March 4, 2020, 3:09am UTC](https://forum.gitlab.com/t/can-i-get-the-markdown-css-files-for-render/29239 "2020-03-04T03:09:58Z")

</div>

I want to render Gitlab’s discussion(comment, merge request…) in my webpage. I thought about two ways. First, Discussions API returns the markdown syntax text. Then My web page will start rendering through the Markdow…

---

## [Mermaid maximum character cound configurable?](https://forum.gitlab.com/t/mermaid-maximum-character-cound-configurable/34799)

<div class="topic-metadata">

**Author:** [@piflixe](https://forum.gitlab.com/u/piflixe)\
**Replies:** 0\
**Last updated:** [February 27, 2020, 10:11am UTC](https://forum.gitlab.com/t/mermaid-maximum-character-cound-configurable/34799 "2020-02-27T10:11:34Z")

</div>

I really love to have the mermaid functionality included in the gitlab markdown. For further information please see https://gitlab.com/help/user/markdown#mermaid However, on our self hosted instance using Version 12.8.1…

---

## [Repo wiki: Linking to images doesn't work when page name includes a colon](https://forum.gitlab.com/t/repo-wiki-linking-to-images-doesnt-work-when-page-name-includes-a-colon/30982)

<div class="topic-metadata">

**Author:** [@MatthiasMayr](https://forum.gitlab.com/u/MatthiasMayr)\
**Replies:** 0\
**Last updated:** [October 18, 2019, 12:14pm UTC](https://forum.gitlab.com/t/repo-wiki-linking-to-images-doesnt-work-when-page-name-includes-a-colon/30982 "2019-10-18T12:14:02Z")

</div>

I sync a wiki repo from a github project. The wiki repo structure looks as follows: imgs/image1.png Home.md Tutorial:-Launch-system.md Now when I want to embed an image in the Home.md I can just put a line !\[alt text…

---

## [Markdown Styling Not Rendering](https://forum.gitlab.com/t/markdown-styling-not-rendering/29628)

<div class="topic-metadata">

**Author:** [@KSpakes87](https://forum.gitlab.com/u/KSpakes87)\
**Replies:** 0\
**Last updated:** [September 4, 2019, 2:56pm UTC](https://forum.gitlab.com/t/markdown-styling-not-rendering/29628 "2019-09-04T14:56:53Z")

</div>

I have been running some tests at work and was asked to put my results in a markdown file. I am using tables to display my results. I didn’t like how it displayed the tables stacked on top of each other making a long lis…

[Next page](https://forum.gitlab.com/tag/markdown/123.md?match_all_tags=true&page=1&tags%5B%5D=markdown)