https://github.com/arthurdenner/snippets-table
Tool to easily manage a table of snippets on a README file.
https://github.com/arthurdenner/snippets-table
Last synced: 7 months ago
JSON representation
Tool to easily manage a table of snippets on a README file.
- Host: GitHub
- URL: https://github.com/arthurdenner/snippets-table
- Owner: arthurdenner
- License: mit
- Created: 2020-04-02T13:46:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T22:54:42.000Z (almost 2 years ago)
- Last Synced: 2024-11-10T13:20:53.463Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.56 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# snippets-table

## 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...
```markdown
```- And run the command:
`npm run snippets-table generate` or `yarn snippets-table generate`## Example
Check the [`example`](./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](https://github.com/arthurdenner/)