Table of Contents

About

A VS Code extension with useful shortcuts.

Built With

Installation

Search for and install 'HTML & Markdown Shortcuts' on Visual Studio Marketplace.

Features

Generate Table of Contents

How to Use

1. Run the command: Run the "Generate Table of Contents" command in the Command Palette (Ctrl+Shift+P).
2. Save: Saving a file also automatically updates the table of contents.
3. Keybindings:
   • Windows/Linux: Ctrl + T, C
   • Mac: Cmd + T, C

Change Case

Pressing Caps Lock changes the casing of selected text.

Toggle Strikethrough

Typing a tilde strikes through selected text.

Roadmap

• [x] Implement change case feature #1
• [x] Implement toggle strikethough feature #2
• [x] Fix case change bug #11
• [x] Add keybindings #9
• [x] Publish the extension to Marketplace #5
• [x] Fix tilde bug #19
• [x] Change license to DBAD [#23]
• [x] Add Generate Table of Contents feature for Markdown files [#37]
• [x] Restrict Change Case command to only work on HTML and Markdown files [#39]
• [x] Add user settings [#38]
• [ ] Implement Add/update/remove section numbering [#40]
• [ ] Implement Generate Table of Contents feature for HTML files.

Contributing

To add a feature or fix a bug, fork the repo and create a pull request.

Example instructions to add a feature:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some amazing feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

To suggest a new feature or report a bug, open an issue.

Changelog

See the changelog here.

Contact Me

Sherpad Ndabambi

License

Distributed under the DBAD License. See LICENSE for more information.

Acknowledgments

1. Logo edited from:

   1. HTML5 badge by W3C.
   2. Markdown mark by Dustin Curtis from GitHub.
   3. Keyboard Command from SVG Repo.
   4. Keyboard Shift Uppercase from SVG Repo.
   5. Ctrl A from SVG Repo.
   6. Spacebar from SVG Repo.

2. Website icon edited from SVG website icon from SVG Repo.

3. Gmail icon edited from Gmail SVG vector from SVG Repo.

4. Images in this project have been compressed using TinyPNG.

5. Parts of this README are based on the Best-README-Template template.