Skip to content
This repository has been archived by the owner on Feb 24, 2023. It is now read-only.

naethiel/fu-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 ...