JSPM

fu-doc

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q20755F
  • License MIT

Command-line mdn docs search tool

Package Exports

  • fu-doc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fu-doc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Search MDN Documentation through the command line

Inspired by go doc, tldr and other CLI-oriented dev documentation, fu-doc is a small command line tool to quickly search through MDN docs.

It can output full MDN pages as markdown, but it is mostly useful to get a quick reminder on things like parameters, return values, usage etc without leaving your terminal.

Install

npm i -g fu-doc

Contribute

  1. git clone git@github.com:naethiel/fu-doc.git
  2. cd fu-doc && npm i
  3. npm run tsc to build the dist from TS sources.
  4. you can use npm start to run the local version of your TS code without having to compile with npm run tsc beforehand
  5. use npm link to make your local copy available as the global fu command

Usage

$ fu <query>.

If you know what you are searching for and want it to be faster, you can use the fast-search flag: $ fu -f array.map to auto-return the first search result

Example

Anything relative to JS, HTML, CSS:

fu array.reduce

fu querySelector

fu flexbox etc ...