Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(doc): fix code block languages #20372

Merged

Conversation

muescha
Copy link
Contributor

@muescha muescha commented Jan 1, 2020

Description

fixed in code blocks:

  • fixed language marker
  • fixed title namings
  • removing trailing $ in shell scripts
  • changed file trees to text

Related Issues

n/a

follow up PR

  • change bash to shell

@muescha muescha requested review from a team as code owners January 1, 2020 15:09
@@ -9,13 +9,13 @@ Benchmarks the current production version of the plugin unless you use `gatsby-d

```shell
# In the root of the Gatsby repository
$ yarn run watch --scope=gatsby-plugin-manifest .
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This denotes a shell input. Not really a "bug" imo.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i know - but i tried to unify it, because the most shell commands in docs are without the $, and it is more convenient for copy paste ...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification. Then it makes more sense.

DanielRuf
DanielRuf previously approved these changes Jan 1, 2020
@muescha
Copy link
Contributor Author

muescha commented Jan 1, 2020

i see now, WebStorm has done automatic some linting in the code blocks while committing - i hope they are ok, otherwise i can revert this code changes.

@muescha muescha force-pushed the muescha/fix/fix-code-block-languages branch from f367590 to 795cd50 Compare January 2, 2020 12:37
Copy link
Contributor

@Ekwuno Ekwuno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes @muescha ! Helpful to add proper labels to code blocks.

@Ekwuno Ekwuno merged commit 985d377 into gatsbyjs:master Jan 7, 2020
@muescha muescha deleted the muescha/fix/fix-code-block-languages branch January 7, 2020 16:22
mwfrost pushed a commit to mwfrost/gatsby that referenced this pull request Apr 20, 2023
* fix code blocks

* revert markdown changes in unordered list
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants