Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
9da18f60
Commit
9da18f60
authored
Jul 19, 2021
by
Marcia Ramos
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Remove link to markdown guide
parent
024ced02
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
13 deletions
+5
-13
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+5
-13
No files found.
doc/development/documentation/styleguide/index.md
View file @
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.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment