Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/artcom/gitbook-plugin-ellipsize

Plugin for gitbook that replaces blocks of code by ellipsis
https://github.com/artcom/gitbook-plugin-ellipsize

Last synced: about 1 month ago
JSON representation

Plugin for gitbook that replaces blocks of code by ellipsis

Awesome Lists containing this project

README

        

# gitbook-plugin-ellipsize

Replace blocks of code by ellipsis

## Installation:

`$ npm install artcom/gitbook-plugin-ellipsize --save`

Add this to `book.json`:
```
{
"plugins": ["ellipsize"]
}
```

## Usage

Define blocks of code that should be omitted with:

```
/* begin ellipsize */

[code that should not be shown on a gitbook page]

/* end ellipsize */
```

This code will be replaced by `// ...` when rendered inside a gitbook page.