Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • T templates
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 8
    • Issues 8
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 4
    • Merge requests 4
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • tecnalia_robotics-public
  • templates
  • Issues
  • #25
Closed
Open
Created Oct 06, 2020 by Oñativia Bravo, Jon@jon.onativiaDeveloper

Add Markdown syntax check exception MD014

The rule "MD014 - Dollar signs used before commands without showing output" is not beneficial for the readability of README.md files. Adding a dollar sign, even if the output is not displayed, helps understand that the line refers to a command line that can be executed in the terminal. For instance, the ROS wiki pages precede all commands with a dollar sign (see for example Navigating the ROS Filesystem for a specific example). This way, you can easily understand if the snippet corresponds to a command or corresponds to something else like the content of a file.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking