Giter Club home page Giter Club logo

docs-extensionpack's Introduction

Docs Extension Pack

A collection of extensions for writing, editing, and reviewing documentation in VS Code

These are some of my favorite extensions to make docs writing easier and fun, and improves my workflow.

Extensions Included

  • Code Spell Checker - A fairly no-fuss spell checker that alerts you to misspelled words and detects camelCase code. Pretty invaluable :)
  • Grammarly (unofficial) - allows you to work with Grammarly in VS Code, not for everyone but easy to disable.
  • Gitlens - GitLens helps you to visualize code authorship at a glance via Git blame annotations and code lens, seamlessly navigate and explore Git repositories, gain valuable insights via powerful comparison commands, and more.
  • Prettier - Never worry about formatting your code ever again, keep everything consistent with ease. My suggestion is to add "editor.tabCompletion": true, "editor.formatOnSave": true, to your settings file in preferences.
  • Formatting toggle This one is a lifesaver! I love Prettier, but there are times I'm submitting PRs to repos with different formatting rules than I have. Rather than having to either shut off Prettier entirely, update my preferences to match theirs, or submit a noisy PR, I can use this extension to toggle formatting with a quickkey and get everything in! I love it.
  • Bracket Pair Colorizer - This extension allows matching brackets to be identified with colours. The user can define which characters to match, and which colours to use. Super handy!
  • Bookmarks - Adds a bookmark to places you designate in your file, and allows you to quickly jump between them. Super helpful. Type command + opt + K to create a bookmark and command + opt + J to jump between them ๐Ÿ”–
  • Jumpy - We lose a lot of time scanning with a mouse, time we can get back by using our keyboard instead. Jumpy provides fast cursor movement by giving you a couple of keys that offer a hook to get to another part of the document.
  • In Bed By 7pm Syntax highlighting can be a very personal thing, so you might not want to use this, but I worked hard creating a theme you might like.

Relevant Links

Dedication

This extension is dedicated to the hardworking Netlify Documentation team โ™ฅ๏ธ

Enjoy!

docs-extensionpack's People

Contributors

sdras avatar souporserious avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

souporserious

docs-extensionpack's Issues

Bracket Pair Colorizer 2 is Deprecated

Background

Whilst I understand that this repo hasn't been looked at for a few years, there might still be people who install it and find it useful. Totally happy for this issue to be completely ignored.

Issue

The extension is Bracket Pair Colourizer 2, and is installed by this extension pack. From reading the documentation for the package, it was marked as deprecated because the feature it provides is now baked into VS Code and enabled by default.

Whilst there's nothing wrong with having a deprecated extension installed, it does mean that it won't receive any updates and VS Code constantly shows a warning about deprecated extensions being installed.

Potential Solutions

A quick win might be to remove the extension from the list of extensions this pack installs. However, it might be worth quizing users (if possible) about whether this will cause them issues with their workflows.

Another win might be to look at other extensions which provide the same functionality. There are quite a few:

It's also possible to ignore this, as it's not (at the moment) a big issue or causing security worries.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.