Skip to content

Commit

Permalink
chore(mdx support): updated README and changed CONTRIBUTING to an mdx…
Browse files Browse the repository at this point in the history
… to show changes
  • Loading branch information
NathanYi authored and NathanYi committed Dec 15, 2023
1 parent 8e12214 commit ba298cc
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 52 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ module.exports = {
],
rules: {
// VS Code linting will not respect the `.prettierrc` options unless injected here:
'prettier/prettier': ['warn', prettierrc],
'prettier/prettier': ['error', prettierrc],
'@typescript-eslint/no-var-requires': 'off',
'@typescript-eslint/no-explicit-any': 'off',
},
Expand Down
47 changes: 0 additions & 47 deletions CONTRIBUTING.md

This file was deleted.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ Options:

<!-- CODEBLOCK_END -->

`markdown-inject` expands a given glob for markdown files. Then it discovers the below `CODEBLOCK` HTML comments within each markdown file, performs the appropriate action (in this case, reading another local file), and writes content back into the markdown file:
`markdown-inject` expands a given glob for markdown files. Then it discovers the below `CODEBLOCK` HTML or MDX comments within each markdown file, performs the appropriate action (in this case, reading another local file), and writes content back into the markdown file:

{/* CODEBLOCK_START_USAGE {"ignore": true} */}
<!-- CODEBLOCK_START_USAGE {"ignore": true} -->

```
<!-- CODEBLOCK_START {"value": ".nvmrc"} -->
Expand All @@ -79,7 +79,7 @@ Options:
<!-- CODEBLOCK_END_USAGE -->

```
{/* CODEBLOCK_START {"value": ".nvmrc"} -->
<!-- CODEBLOCK_START {"value": ".nvmrc"} -->
<!-- prettier-ignore -->
~~~~~~~~~~bash
File: .nvmrc
Expand Down
1 change: 0 additions & 1 deletion src/md-inject.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ const main = async (
groupValue,
])
)
console.log(matchGroups)
try {
let inputConfig: BlockInputOptions
try {
Expand Down

0 comments on commit ba298cc

Please sign in to comment.