Skip to content

Commit

Permalink
chore: update extension metadata content and README (#214)
Browse files Browse the repository at this point in the history
Co-authored-by: JounQin <admin@1stg.me>
  • Loading branch information
remcohaszing and JounQin committed Aug 18, 2022
1 parent 390198a commit 4275105
Show file tree
Hide file tree
Showing 6 changed files with 289 additions and 319 deletions.
5 changes: 5 additions & 0 deletions .changeset/sixty-geckos-design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"vscode-mdx": patch
---

chore: update extension metadata content and README
1 change: 0 additions & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"overrides": [
{
"files": [
".github/*.yml",
"syntaxes/*.json"
],
"rules": {
Expand Down
5 changes: 5 additions & 0 deletions .remarkrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"plugins": [
"@1stg/preset"
]
}
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# [Visual Studio Code](https://code.visualstudio.com) extension for [MDX]
# [Visual Studio Code](https://code.visualstudio.com) extension for [MDX][]

[![GitHub Actions](https://github.com/mdx-js/vscode-mdx/workflows/CI/badge.svg)](https://github.com/mdx-js/vscode-mdx/actions/workflows/ci.yml)
[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/unifiedjs.vscode-mdx)](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx)
[![GitHub release](https://img.shields.io/github/release/mdx-js/vscode-mdx)](https://github.com/mdx-js/vscode-mdx/releases)
[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/unifiedjs.vscode-mdx)](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx)
[![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)

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

Adds language support for [MDX].
Adds language support for [MDX][].

## Installation

Expand Down Expand Up @@ -76,7 +78,7 @@ Please add the following setting to use system default Node runtime instead:
}
```

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

2. `JavaScript heap out of memory`

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

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

## Sponsors

Expand Down
16 changes: 10 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "vscode-mdx",
"version": "1.0.1",
"displayName": "VSCode MDX",
"description": "Visual Studio Code extension for MDX",
"displayName": "MDX",
"description": "Language support for MDX",
"categories": [
"Programming Languages"
],
Expand Down Expand Up @@ -44,6 +44,9 @@
"type": "opencollective",
"url": "https://opencollective.com/unified"
},
"sponsor": {
"url": "https://github.com/mdx-js/vscode-mdx?sponsor=1"
},
"license": "MIT",
"private": true,
"packageManager": "yarn@1.22.19",
Expand All @@ -60,12 +63,12 @@
"prepare": "patch-package && simple-git-hooks && yarn-deduplicate --strategy fewer || exit 0"
},
"devDependencies": {
"@1stg/common-config": "^6.1.4",
"@1stg/common-config": "^7.0.0",
"@changesets/changelog-github": "^0.4.6",
"@changesets/cli": "^2.24.2",
"@changesets/cli": "^2.24.3",
"patch-package": "^6.4.7",
"typescript": "^4.7.4",
"yarn-deduplicate": "^5.0.0"
"yarn-deduplicate": "^5.0.2"
},
"resolutions": {
"prettier": "^2.7.1"
Expand Down Expand Up @@ -141,5 +144,6 @@
}
}
]
}
},
"qna": "https://github.com/orgs/mdx-js/discussions"
}
Loading

0 comments on commit 4275105

Please sign in to comment.