Skip to content

Tool to easily manage a table of snippets on a README file.

License

Notifications You must be signed in to change notification settings

arthurdenner/snippets-table

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

snippets-table

npm

Overview

Tool to easily manage a table of snippets on a README file.

Installation

Install the package:

npm i --dev snippets-table or yarn add -D snippets-table

Usage

  • Run it with npx:

    • npx snippets-table generate
  • Or add the following lines to the README where the table of snippets should be created...

    <!-- SNIPPETS-TABLE:START - Do not remove or modify this line -->
    
    <!-- SNIPPETS-TABLE:END -->
  • And run the command: npm run snippets-table generate or yarn snippets-table generate

Example

Check the example folder for more details.

After using this library, a table like below will be created:

Prefix Name Description
abc Sing ABC Song by Jackson 5
help Sing Help Song by The Beatles
takeOnMe Sing Take on Me Song by a-ha

Configuration

Name Default
pathToREADME README.md
pathToSnippets snippets/snippets.json
headers ["Prefix","Name","Description"]

Run snippets-table --help for more.

License

MIT © Arthur Denner

About

Tool to easily manage a table of snippets on a README file.

Resources

License

Stars

Watchers

Forks

Packages

No packages published