Skip to content

Remove $ signs from terminal code examples #103

@bidoubiwa

Description

@bidoubiwa

Following these issues #99 and #102, README.md should be updated like this

1. Remove $ in front of command lines

closes: #99
example: meilisearch/meilisearch-js/pull/827
As stated in de markdownlint recommendetation, $ should not be displayed if no output of the commands are showed.

Example:

Wrong ❌: no output, no $ signs

$ ls
$ cat foo
$ less bar

Correct: ✅

ls
cat foo
less bar

Correct: ✅. As there are output, there should be a $ signed to

$ ls
foo bar
$ cat foo
Hello world
$ cat bar
baz

These dollar signs should be removed from the following files:

  • README.md
  • CONTRIBUTING.md
  • .code-samples.meilisearch.yaml
  • any other markdown file in a sub directory

TODO

Remove $

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions