Skip to content

A simple CLI tool to open documentation links defined in a json file.

License

Notifications You must be signed in to change notification settings

Michael-Gibbons/doc-me

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doc-me

A simple CLI tool to open documentation links defined in a json file.

#USAGE

npm i @michael.gibbons/doc-me

In your package.json, create a doc property as an array of key value pairs of the URLs you would like to reference. Like so.

  ...
  "doc": [
    {
      "name":"google",
      "value": "https://google.com"
    },
    {
      "name": "youtube",
      "value": "https://youtube.com"
    }
  ]

Then run npx doc when you would like to reference your urls.

About

A simple CLI tool to open documentation links defined in a json file.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published