Skip to content

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

License

Notifications You must be signed in to change notification settings

heckman/markdown-footnote

 
 

Repository files navigation

VSCode Markdown Footnote

VSCode Markdown Footnote

[^1] footnote syntax 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

  • Peek editor for quick editing and preview.

    Peek footnote content

    Peek footnote references

  • Command for inserting new footnote

    Click to create a new footnote

    Use command to insert a footnote

  • Render footnotes in the built-in markdown preview.

    Preview

TODO

  • Support multiline footnote content.
  • Support pandoc-citeproc format citations

Contributing

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

Changelog

See changelog here.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.1%
  • JavaScript 6.9%
  • Shell 1.0%