kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Fix broken markdown and other lint problems

Browse source
This commit is contained in:
Evan Read 2019-01-08 10:21:31 +10:00
parent a0aca3ac3a
commit 868d8ec6e7
1 changed files with 30 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/development/documentation/styleguide.md
View file

@ -29,7 +29,7 @@ a test that will fail if it spots a new `README.md` file.
### Markdown ### Markdown
The [documentation website](https://docs.gitlab.com) had its markdown engine migrated from [Redcarpet to GitLab Kramdown](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/108) The [documentation website](https://docs.gitlab.com) had its markdown engine migrated from [Redcarpet to GitLab Kramdown](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/108)
in October, 2018. in October 2018.
The [`gitlab-kramdown`](https://gitlab.com/gitlab-org/gitlab_kramdown) The [`gitlab-kramdown`](https://gitlab.com/gitlab-org/gitlab_kramdown)
gem will support all [GFM markup](../../user/markdown.md) in the future. For now, gem will support all [GFM markup](../../user/markdown.md) in the future. For now,
@ -226,7 +226,6 @@ For other punctuation rules, please refer to the
To indicate the steps of navigation through the UI: To indicate the steps of navigation through the UI:
- Use the exact word as shown in the UI, including any capital letters as-is. - Use the exact word as shown in the UI, including any capital letters as-is.
- Use bold text for navigation items and the char "greater than" (`>`) as separator - Use bold text for navigation items and the char "greater than" (`>`) as separator
(e.g., `Navigate to your project's **Settings > CI/CD**` ). (e.g., `Navigate to your project's **Settings > CI/CD**` ).
@ -592,12 +591,12 @@ on this document. Further explanation is given below.
The following can be used as a template to get started: The following can be used as a template to get started:
```md ````md
## Descriptive title ## Descriptive title
One or two sentence description of what endpoint does. One or two sentence description of what endpoint does.
``` ```text
METHOD /endpoint METHOD /endpoint
``` ```
@ -609,7 +608,7 @@ METHOD /endpoint
Example request: Example request:
```sh ```sh
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" 'https://gitlab.example.com/api/v4/endpoint?parameters' curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/endpoint?parameters'
``` ```
Example response: Example response:
@ -620,8 +619,7 @@ Example response:
} }
] ]
``` ```
````
```
### Fake tokens ### Fake tokens