https://github.com/hackmdio/vscode-hackmd

The official HackMD VScode extension!
https://github.com/hackmdio/vscode-hackmd

Last synced: 12 days ago
JSON representation

The official HackMD VScode extension!

• Host: GitHub
• URL: https://github.com/hackmdio/vscode-hackmd
• Owner: hackmdio
• License: mit
• Created: 2019-07-25T06:46:39.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2023-03-15T09:30:02.000Z (over 1 year ago)
• Last Synced: 2024-08-01T19:56:20.076Z (3 months ago)
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=HackMD.vscode-hackmd
• Size: 3.46 MB
• Stars: 130
• Watchers: 7
• Forks: 15
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The official HackMD Markdown VSCode extension

Use the same [HackMD](https://hackmd.io) markdown right in VSCode!

![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/HackMD.vscode-hackmd)

![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/HackMD.vscode-hackmd)

## Features

- **New**: Edit your notes right in VSCode!

- **New**: Browse your team notes in the HackMD explorer view

- Preview your HackMD notes in VSCode

- Create the note from editor's content

- HackMD-compatible markdown rendering preview

  - We bring most HackMD markdown syntax into VSCode :tada:

### HackMD notes explorer

![sidebar](./docs/media/notes_explorer.png)

### Render code block with line numbers

![line-numbers](https://i.imgur.com/X31HZqm.png)

### MathJax, Diagrams

![mathjax](https://i.imgur.com/6vpxBbo.png)

![Sequence-diagram](https://i.imgur.com/pinXrf6.png)

![mermaid](https://i.imgur.com/M15g6It.png)

## Release Notes

[Read the full Release Note on HackMD.][release-notes]

[release-notes]: https://bit.ly/2VXRTrq

### 2.1.0

#### Added

- You can now edit notes in your workspace

- Support deleting files from the notes explorer

- Add an API limit status bar item. When you're reaching your limit, we'll let you know

#### Improvements

- New iconography to match Visual Studio Code style

- Update `@hackmd/api` to 2.4.0

#### Fixes

- Update `react-vsc-treeview` to our own maintained fork, fixing bugs when refreshing the tree view

### 2.0.0

#### Added

- Adopt access token-based API client. You need to create an access token on the HackMD [settings page](https://hackmd.io/settings#api)

- Add two more tree views: History and Team Notes.

#### Improvements

- Upgrade highlight.js

- Upgrade mermaid

- Upgrade more dependencies

- Adopt `react-vsc-treeview` package for implementing the new tree views. It's now easier to add features and fix bugs for the tree view.

- Reduce bundle size. We accidentally include `node_modules` in our past builds, which is not necessary.

### 1.1.1

#### Added

- HackMD Snippets command

  - Use the command: `HackMD: Create a code snippet` to create a code snippet on HackMD from the selected text range

#### Fixed

- Activity icon is not shown ([#23](https://github.com/hackmdio/vscode-hackmd/issues/23))

### 1.1.0

#### Added

- HackMD Note explorer

  - Preview your notes on HackMD

  - Create a note from editor content in VSCode

### 1.0.0

Initial Release!

#### Added

- markdown-it plugins

  - markdown-it-abbr

  - markdown-it-container

  - markdown-it-deflist

  - markdown-it-ins

  - markdown-it-mark

  - markdown-it-mathjax

  - markdown-it-sub

  - markdown-it-sup

  - checkbox (As extension dependency)

  - markdown-it-emoji

  - markdown-it-footnote

  - markdown-it-imsize

- External Graph Renderer

  - Mermaid

  - Sequence Diagram

  - Flowchart

  - Graphviz

  - abc.js

  - Mathjax