Checkbox Enhancement

This extension is designed to enhance the functionality of the checkbox in markdown files. It is designed to work with the markdown preview and the markdown editor.

Features

So far the main and only feature is a counter for the number of checked checkboxes in the markdown file. This counter is displayed in the status bar. You can change the format of the counter by clicking on it or executing the Checkbox Enhancement: Change Counter Format command.

https://github.com/jamerrq/checkbox-md-enhancement/assets/35697365/50e085ad-989c-4ca0-a538-8789f476ea95

To show/hide the counter, you can use the Checkbox Enhancement: Toggle Counter command.

More features will be added in the future.

Release Notes

0.0.2

Initial release of Checkbox Enhancement

• Added checkbox counter to the status bar
• Percentage format added to the counter

0.0.3

• Release notes added to the README.md file

Contributing

Contributions / asking for features are welcome. Feel free to open an issue or a pull request on the GitHub repository of the project.

These are some of the features that I would like to add in the future:

• [ ] Color change according to the percentage of checked checkboxes
• [ ] Mode for show both percentage and number of checked checkboxes
• [ ] Option to show the counter in the markdown preview
• [ ] Option to show the counter for separate lists in the document

To contribute, clone the repository first:

git clone git@github.com:jamerrq/checkbox-md-enhancement.git

Then, install the dependencies:

cd checkbox-md-enhancement
pnpm install

After that, you can open the project in Visual Studio Code and start developing. Use the F5 key to start the extension in a new window. I strongly recommend creating a new branch for your changes.

git checkout -b feature/my-new-feature

When you are done, you can open a pull request on the GitHub repository.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference