Skip to content

Update styleguide.md #68

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

Merged
merged 1 commit into from
May 2, 2022
Merged

Update styleguide.md #68

merged 1 commit into from
May 2, 2022

Conversation

ntwb
Copy link
Member

@ntwb ntwb commented May 2, 2022

Follow up to #66 to update markdown format for https://developer.wordpress.org/coding-standards/styleguide/

This resolves most issues with this file except for these two issues:

styleguide.md:102:30 MD033/no-inline-html Inline HTML [Element: code]
styleguide.md:110:47 MD033/no-inline-html Inline HTML [Element: code]

For the first and last lines of this section of code:

wpcs-docs/styleguide.md

Lines 98 to 105 in 776433c

Wrap inline code with <code>`\``</code> backticks:
````
```
This is `inline code` wrapped with backticks
```
````
When documenting an example, use the markdown <code>`\``</code> code block to demarcate the beginning and end of the code sample:

This had been previously tried, but the parser didn't like this change eb0aa61#diff-43a6652a89d7d4621d2a09e2f299221d56063e27e66431443b319451e8e82e0a

Can possibly add an ignore-directive for markdownlint for this

@ntwb ntwb merged commit 24a0f83 into master May 2, 2022
@ntwb ntwb deleted the update-styleguide branch May 2, 2022 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants