Skip to content

Add vale rule for codeblock fences

Marcel Amirault requested to merge vale-backtick-fences-rule into master

What does this MR do?

This adds a Vale rule to make sure we all use the same language tags for codeblocks. This makes sure there is a consistent standard across all docs, to reduce confusion. "Is shell the same as bash? Is text the same as plaintext?". It also makes it easier to read.

For reference:

  • yml -> yaml
  • rb -> ruby
  • text -> plaintext
  • md -> markdown
  • bash/sh -> shell
  • js -> javascript
  • go -> golang
  • py -> python
  • docker -> dockerfile
  • ts -> typescript

Style guide link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#code-blocks

Closes #218321 (closed)

Edited by 🤖 GitLab Bot 🤖

Merge request reports