#mdndoc

mdndoc lets you read MDN documentation in the terminal

#Usage

Run with no parameters to fuzzy search all MDN pages:

$ mdndoc

Additional arguments are passed to fzf as the initial query. If there is only one match, the page is opened immediately

$ mdndoc addeventlistener
$ mdndoc canvas context image

#Dependencies

You must have the following programs installed to use mdndoc.

• pandoc
• fzf
• find

#Install

git clone git.sr.ht/~ajpaon/mdndoc

cd mdndoc

# install to /usr/local/bin
sudo make install

# or install elsewhere
make PREFIX=~/.local install

This repo does not bundle mdn-content. You need to clone it separately and tell mdndoc where you saved it. For example:

git clone https://github.com/mdn/content ~/src/mdn-content

# in .bashrc:
export MDNDOC_MDN_PATH=~/src/mdn-content

#Contributing

Please email ~ajpaon/public-inbox@lists.sr.ht with any bugs, feature requests, or patches.