Skip to content

Commit 4275105

Browse files
chore: update extension metadata content and README (#214)
Co-authored-by: JounQin <[email protected]>
1 parent 390198a commit 4275105

File tree

6 files changed

+289
-319
lines changed

6 files changed

+289
-319
lines changed

.changeset/sixty-geckos-design.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"vscode-mdx": patch
3+
---
4+
5+
chore: update extension metadata content and README

.eslintrc

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
"overrides": [
55
{
66
"files": [
7-
".github/*.yml",
87
"syntaxes/*.json"
98
],
109
"rules": {

.remarkrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"plugins": [
3+
"@1stg/preset"
4+
]
5+
}

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
# [Visual Studio Code](https://code.visualstudio.com) extension for [MDX]
1+
# [Visual Studio Code](https://code.visualstudio.com) extension for [MDX][]
22

33
[![GitHub Actions](https://github.com/mdx-js/vscode-mdx/workflows/CI/badge.svg)](https://github.com/mdx-js/vscode-mdx/actions/workflows/ci.yml)
44
[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/unifiedjs.vscode-mdx)](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx)
55
[![GitHub release](https://img.shields.io/github/release/mdx-js/vscode-mdx)](https://github.com/mdx-js/vscode-mdx/releases)
66
[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/unifiedjs.vscode-mdx)](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx)
7+
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/mdx-js/vscode-mdx.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/mdx-js/vscode-mdx/context:javascript)
78

8-
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
99
[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
10-
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
11-
[![changesets](https://img.shields.io/badge/maintained%20with-changesets-cc00ff.svg)](https://github.com/changesets/changesets)
10+
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
11+
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)
12+
[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
13+
[![changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/changesets/changesets)
1214

13-
Adds language support for [MDX].
15+
Adds language support for [MDX][].
1416

1517
## Installation
1618

@@ -76,7 +78,7 @@ Please add the following setting to use system default Node runtime instead:
7678
}
7779
```
7880

79-
Please visit https://github.com/microsoft/vscode-eslint/issues/1498#issuecomment-1175813839 as reference for details.
81+
Please visit <https://github.com/microsoft/vscode-eslint/issues/1498#issuecomment-1175813839> as reference for details.
8082

8183
2. `JavaScript heap out of memory`
8284

@@ -88,7 +90,7 @@ The default memory limit of Node.js is `1G`, please add the following setting to
8890
}
8991
```
9092

91-
Please visit https://github.com/microsoft/vscode-eslint/issues/733 as reference for details.
93+
Please visit <https://github.com/microsoft/vscode-eslint/issues/733> as reference for details.
9294

9395
## Sponsors
9496

package.json

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "vscode-mdx",
33
"version": "1.0.1",
4-
"displayName": "VSCode MDX",
5-
"description": "Visual Studio Code extension for MDX",
4+
"displayName": "MDX",
5+
"description": "Language support for MDX",
66
"categories": [
77
"Programming Languages"
88
],
@@ -44,6 +44,9 @@
4444
"type": "opencollective",
4545
"url": "https://opencollective.com/unified"
4646
},
47+
"sponsor": {
48+
"url": "https://github.com/mdx-js/vscode-mdx?sponsor=1"
49+
},
4750
"license": "MIT",
4851
"private": true,
4952
"packageManager": "[email protected]",
@@ -60,12 +63,12 @@
6063
"prepare": "patch-package && simple-git-hooks && yarn-deduplicate --strategy fewer || exit 0"
6164
},
6265
"devDependencies": {
63-
"@1stg/common-config": "^6.1.4",
66+
"@1stg/common-config": "^7.0.0",
6467
"@changesets/changelog-github": "^0.4.6",
65-
"@changesets/cli": "^2.24.2",
68+
"@changesets/cli": "^2.24.3",
6669
"patch-package": "^6.4.7",
6770
"typescript": "^4.7.4",
68-
"yarn-deduplicate": "^5.0.0"
71+
"yarn-deduplicate": "^5.0.2"
6972
},
7073
"resolutions": {
7174
"prettier": "^2.7.1"
@@ -141,5 +144,6 @@
141144
}
142145
}
143146
]
144-
}
147+
},
148+
"qna": "https://github.com/orgs/mdx-js/discussions"
145149
}

0 commit comments

Comments
 (0)