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
0
Merge Requests
0
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
Léo-Paul Géneau
gitlab-ce
Commits
868719e9
Commit
868719e9
authored
Nov 02, 2018
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add a new markup languages section
parent
2a450e21
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
24 additions
and
10 deletions
+24
-10
doc/user/project/repository/index.md
doc/user/project/repository/index.md
+24
-10
No files found.
doc/user/project/repository/index.md
View file @
868719e9
...
...
@@ -53,17 +53,35 @@ To get started with the command line, please read through the
Use GitLab's
[
file finder
](
../../../workflow/file_finder.md
)
to search for files in a repository.
### Supported markup languages and extensions
GitLab supports a number of markup languages (sometimes called
[
lightweight
markup languages
](
https://en.wikipedia.org/wiki/Lightweight_markup_language
)
)
that you can use for the content of your files in a repository. They are mostly
used for documentation purposes.
Just pick the right extension for your files and GitLab will render them
according to the markup language.
| Markup language | Extensions |
| --------------- | ---------- |
| Plain text |
`txt`
|
|
[
Markdown
](
../../markdown.md
)
|
`mdown`
,
`mkd`
,
`mkdn`
,
`md`
,
`markdown`
|
|
[
reStructuredText
](
http://docutils.sourceforge.net/rst.html
)
|
`rst`
|
|
[
Asciidoc
](
https://asciidoctor.org/docs/what-is-asciidoc/
)
|
`adoc`
,
`ad`
,
`asciidoc`
|
|
[
Textile
](
https://txstyle.org/
)
|
`textile`
|
|
[
rdoc
](
http://rdoc.sourceforge.net/doc/index.html
)
|
`rdoc`
|
|
[
Orgmode
](
https://orgmode.org/
)
|
`org`
|
|
[
creole
](
http://www.wikicreole.org/
)
|
`creole`
|
|
[
Mediawiki
](
https://www.mediawiki.org/wiki/MediaWiki
)
|
`wiki`
,
`mediawiki`
|
### Repository README and index files
When a
`README`
or
`index`
file is present in a repository, its contents will be
automatically pre-rendered by GitLab without opening it.
They can either be plain text or have an extension of a supported markup language:
-
Asciidoc:
`README.adoc`
or
`index.adoc`
-
Markdown:
`README.md`
or
`index.md`
-
reStructuredText:
`README.rst`
or
`index.rst`
-
Text:
`README.txt`
or
`index.txt`
They can either be plain text or have an extension of a
[
supported markup language
](
#supported-markup-languages-and-extensions
)
:
Some things to note about precedence:
...
...
@@ -75,10 +93,6 @@ Some things to note about precedence:
precedence over
`README.md`
, and
`README.rst`
will take precedence over
`README`
.
NOTE:
**Note:**
`index`
files without an extension will not automatically pre-render. You'll
have to explicitly open them to see their contents.
### Jupyter Notebook files
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/2508) in GitLab 9.1
...
...
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