https://github.com/houkanshan/vscode-markdown-footnote

[^1] footnote syntax support to VS Code's Markdown editor and preview.
https://github.com/houkanshan/vscode-markdown-footnote

vscode-extension

Last synced: about 2 months ago
JSON representation

[^1] footnote syntax support to VS Code's Markdown editor and preview.

• Host: GitHub
• URL: https://github.com/houkanshan/vscode-markdown-footnote
• Owner: houkanshan
• License: mit
• Created: 2020-08-13T23:24:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-24T21:27:49.000Z (about 1 year ago)
• Last Synced: 2024-08-03T15:11:47.354Z (5 months ago)
• Topics: vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=houkanshan.vscode-markdown-footnote
• Size: 5.25 MB
• Stars: 14
• Watchers: 3
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



VSCode Markdown Footnote


[![](https://vsmarketplacebadge.apphb.com/version-short/houkanshan.vscode-markdown-footnote.svg)](https://marketplace.visualstudio.com/items?itemName=houkanshan.vscode-markdown-footnote)

[![](https://vsmarketplacebadge.apphb.com/installs/houkanshan.vscode-markdown-footnote.svg)](https://marketplace.visualstudio.com/items?itemName=houkanshan.vscode-markdown-footnote)

[![](https://vsmarketplacebadge.apphb.com/rating-short/houkanshan.vscode-markdown-footnote.svg)](https://marketplace.visualstudio.com/items?itemName=houkanshan.vscode-markdown-footnote&ssr=false#review-details)

[![](https://github.com/houkanshan/vscode-markdown-footnote/workflows/CI/badge.svg?branch=master)](https://github.com/houkanshan/vscode-markdown-footnote/actions?query=workflow%3ACI+branch%3Amaster)

`[^1]` [footnote syntax](https://www.markdownguide.org/extended-syntax/#footnotes) support to VS Code's Markdown editor and preview.

## Features

- Hover to preview and jump between footnote reference and content by cmd / ctrl + click.

  ![Hover preview](assets/hover.png)

- Peek editor for quick editing and preview.

  ![Peek footnote content](assets/peek-content.png)

  ![Peek footnote references](assets/peek-references.png)

- Command for inserting new footnote

  ![Click to create a new footnote](assets/click-to-create.png)

  ![Use command to insert a footnote](assets/command-to-insert.png)

- Render footnotes in the built-in markdown preview.

  ![Preview](assets/preview.png)

### TODO

- Support multiline footnote content.

- Support `pandoc-citeproc` format [citations](https://crsh.github.io/papaja_man/writing.html#citations)

## Contributing

- File bugs, feature requests in [GitHub Issues](https://github.com/houkanshan/vscode-markdown-footnote/issues).

- Leave a review on [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=houkanshan.vscode-markdown-footnote&ssr=false#review-details).

### Dev

- Fork this repository

- `npm install`

- Create your feature branch: `git checkout -b my-new-feature`

- Make changes and add tests

- `npm test:watch` and check your changes by pressing `F5`

- Commit your changes: `git commit -am 'feat: Add some feature'`

- Push to the branch: `git push origin my-new-feature`

- Submit a pull request

## Thanks

- [Markdown Footnotes](https://github.com/mjbvz/vscode-markdown-footnotes)

- [Markdown Memo](https://github.com/svsool/vscode-memo)

## Changelog

See changelog [here](./CHANGELOG.md).