https://github.com/teradata/gitbook-plugin-snippets
GitBook snippets plugin.
https://github.com/teradata/gitbook-plugin-snippets
Last synced: 8 months ago
JSON representation
GitBook snippets plugin.
- Host: GitHub
- URL: https://github.com/teradata/gitbook-plugin-snippets
- Owner: Teradata
- License: mit
- Created: 2016-07-15T20:19:14.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-15T20:54:10.000Z (almost 10 years ago)
- Last Synced: 2025-08-09T07:08:48.905Z (9 months ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 6
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitBook Snippets Plugin
Provides a basic reusable snippet functionality for GitBook. It supports using properties files for key/values that will be searched/replaced in the content.
It is most useful for inline or simple strings that you might reuse, such as links or names.
### How it works
Install it using `npm install --save gitbook-plugin-snippets` and then update the `book.json` to include the following values.
```json
{
"plugins": [
"snippets"
],
"pluginsConfig": {
"snippets": {
"file": "snippets.properties"
}
}
}
```
The `pluginsConfig.snippets.file` property should be the path or url to a properties file.
The plugin uses the [properties](https://www.npmjs.com/package/properties) module to load and parse the file. It currently only supports top level properties, meaning you cannot namespace or nest sections. Here is an example.
```properties
200_STATUS=Request was successful.
404_STATUS=The resource was not found.
```
Now in order to consume this, you just place the key in your content and it will be replaced inline.
### License
[MIT](./LICENSE)