Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.11 KB

README.md

File metadata and controls

40 lines (24 loc) · 1.11 KB

boringdocs documentation

This is the boringdocs VSCode extension that gives you the documentation of sailsjs and the boring javascript stack.

Features

Both docs will open within VSCode so you won't lose context!

Sails

  • Type the command boringdocs.sails
  • or simply press
    • windows: ctrl+shift+1
    • mac: ctrl+cmd+1

sails docs gif

The boring stack

  • Type the command boringdocs.tbjs
  • or simply press
    • windows: ctrl+shift+2
    • mac: ctrl+cmd+2

tbjs docs gif

Side note: If it loads slowly on first try, do not fret. The pages are cached automatically so it loads faster on the next.

Hover feature

Hover on a keyword used in sailsjs and the boring stack to get a summary about that keyword.

hover1 gif hover2 gif

Issues & Feature requests

Issues and feature requests related to the extension can be submitted on Github

Enjoy!