Commit 647ea551 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'docs-dev-guidelines-clarify-md-engine' into 'master'

Docs: Remove link to markdown guide

See merge request gitlab-org/gitlab!66381
parents bea8f1f0 9da18f60
...@@ -129,22 +129,14 @@ the documentation. ...@@ -129,22 +129,14 @@ the documentation.
All GitLab documentation is written using [Markdown](https://en.wikipedia.org/wiki/Markdown). All GitLab documentation is written using [Markdown](https://en.wikipedia.org/wiki/Markdown).
The [documentation website](https://docs.gitlab.com) uses GitLab Kramdown as its The [documentation website](https://docs.gitlab.com) uses [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown),
Markdown rendering engine. For a complete Kramdown reference, see the a "flavored" Kramdown engine to render pages from Markdown to HTML. The use of Kramdown's
[GitLab Markdown Kramdown Guide](https://about.gitlab.com/handbook/markdown-guide/). features is limited by our linters, so, use regular Markdown and follow the rules in the
linked style guide. You can't use Kramdown-specific markup (for example, `{:.class}`).
The [`gitlab-kramdown`](https://gitlab.com/gitlab-org/gitlab_kramdown) Ruby gem
plans to support all [GitLab Flavored Markdown](../../../user/markdown.md) in the future, which is
all Markdown supported for display in the GitLab application itself. For now, use
regular Markdown and follow the rules in the linked style guide.
Kramdown-specific markup (for example, `{:.class}`) doesn't render
properly on GitLab instances under [`/help`](../index.md#gitlab-help).
### HTML in Markdown ### HTML in Markdown
Hard-coded HTML is valid, although it's discouraged from being used while we Hard-coded HTML is valid, although it's discouraged from being used. HTML is permitted if:
have `/help`. HTML is permitted if:
- There's no equivalent markup in Markdown. - There's no equivalent markup in Markdown.
- Advanced tables are necessary. - Advanced tables are necessary.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment