Skip to content

Commit

Permalink
docs: reference vscode ext in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hougesen committed Feb 5, 2025
1 parent 17a2b37 commit 233c6a3
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [Unreleased](https://github.com/hougesen/mdsf/compare/v0.4.1...HEAD)

- docs: reference vscode ext in readme [`#673`](https://github.com/hougesen/mdsf/pull/673)
- chore(vscode): release workflow [`#672`](https://github.com/hougesen/mdsf/pull/672)
- docs(vscode): basic usage [`#671`](https://github.com/hougesen/mdsf/pull/671)
- chore(vscode): add metadata keys to package.json [`#670`](https://github.com/hougesen/mdsf/pull/670)
Expand Down Expand Up @@ -48,6 +49,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
- test: add tests for markdownlint [`#621`](https://github.com/hougesen/mdsf/pull/621)
- feat: add support for mado [`#620`](https://github.com/hougesen/mdsf/pull/620)
- feat: add option to ignore output of tool [`#619`](https://github.com/hougesen/mdsf/pull/619)
- chore(vscode): release workflow (#672) [`#648`](https://github.com/hougesen/mdsf/issues/648)
- feat: respect existing codeblock indentation (#628) [`#616`](https://github.com/hougesen/mdsf/issues/616)
- feat: add support for mado (#620) [`#617`](https://github.com/hougesen/mdsf/issues/617)

Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Format, and lint, markdown code snippets using your favorite tools.
- [Cargo](#cargo)
- [npm/npx](#npmnpx)
- [Homebrew](#homebrew)
- [Editors](#editors)
- [Visual Studio Code](#visual-studio-code)
- [Usage](#usage)
- [Formatting code](#formatting-code)
- [Verifying code](#verifying-code)
Expand Down Expand Up @@ -96,6 +98,19 @@ npx mdsf-cli format .
brew install hougesen/tap/mdsf
```

#### Editors

##### Visual Studio Code

[![](https://img.shields.io/visual-studio-marketplace/v/hougesen.mdsf?color=374151&label=Visual%20Studio%20Marketplace&labelColor=000&logo=visual-studio-code&logoColor=0098FF)](https://marketplace.visualstudio.com/items?itemName=hougesen.mdsf)
[![](https://img.shields.io/visual-studio-marketplace/v/hougesen.mdsf?color=374151&label=Open%20VSX%20Registry&labelColor=000&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyB2aWV3Qm94PSI0LjYgNSA5Ni4yIDEyMi43IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogIDxwYXRoIGQ9Ik0zMCA0NC4yTDUyLjYgNUg3LjN6TTQuNiA4OC41aDQ1LjNMMjcuMiA0OS40em01MSAwbDIyLjYgMzkuMiAyMi42LTM5LjJ6IiBmaWxsPSIjYzE2MGVmIi8+CiAgPHBhdGggZD0iTTUyLjYgNUwzMCA0NC4yaDQ1LjJ6TTI3LjIgNDkuNGwyMi43IDM5LjEgMjIuNi0zOS4xem01MSAwTDU1LjYgODguNWg0NS4yeiIgZmlsbD0iI2E2MGVlNSIvPgo8L3N2Zz4=&logoColor=0098FF)](https://open-vsx.org/extension/hougesen/mdsf)

mdsf can be run easily using the VSCode extension.

> \[!NOTE\]
> The mdsf VS Code extension does currently not support installing mdsf.
> Which means mdsf must be installed using other means.
## Usage

<!-- START_SECTION:base-command-help -->
Expand Down
3 changes: 3 additions & 0 deletions mdsf-vscode/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# mdsf Visual Studio Code Extension

[![](https://img.shields.io/visual-studio-marketplace/v/hougesen.mdsf?color=374151&label=Visual%20Studio%20Marketplace&labelColor=000&logo=visual-studio-code&logoColor=0098FF)](https://marketplace.visualstudio.com/items?itemName=hougesen.mdsf)
[![](https://img.shields.io/visual-studio-marketplace/v/hougesen.mdsf?color=374151&label=Open%20VSX%20Registry&labelColor=000&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyB2aWV3Qm94PSI0LjYgNSA5Ni4yIDEyMi43IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogIDxwYXRoIGQ9Ik0zMCA0NC4yTDUyLjYgNUg3LjN6TTQuNiA4OC41aDQ1LjNMMjcuMiA0OS40em01MSAwbDIyLjYgMzkuMiAyMi42LTM5LjJ6IiBmaWxsPSIjYzE2MGVmIi8+CiAgPHBhdGggZD0iTTUyLjYgNUwzMCA0NC4yaDQ1LjJ6TTI3LjIgNDkuNGwyMi43IDM5LjEgMjIuNi0zOS4xem01MSAwTDU1LjYgODguNWg0NS4yeiIgZmlsbD0iI2E2MGVlNSIvPgo8L3N2Zz4=&logoColor=0098FF)](https://open-vsx.org/extension/hougesen/mdsf)

mdsf is a code formatter for markdown files that allows you run execute ordinary formatters like rustfmt, gofmt and stylua on markdown code blocks.

## Usage
Expand Down

0 comments on commit 233c6a3

Please sign in to comment.