# gitbook-plugin-blueprint-tour

> Gitbook plugin to display an interactive tour of a Brooklyn blueprint

Latest version **1.0.0** (published 2017-11-01) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install gitbook-plugin-blueprint-tour
pnpm add gitbook-plugin-blueprint-tour
yarn add gitbook-plugin-blueprint-tour
bun add gitbook-plugin-blueprint-tour
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-11-01 |
| First published | 2017-11-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Thomas Bouron |
| Maintainers | tbouron |

## Links

- npm: https://www.npmjs.com/package/gitbook-plugin-blueprint-tour
- npm.io page: https://npm.io/package/gitbook-plugin-blueprint-tour

## Dependencies (1)

- [gitbook-markdown](https://npm.io/package/gitbook-markdown.md) ^2.0.1

## Recent versions

- 1.0.0 (latest) — 2017-11-01

## README

# gitbook-plugin-blueprint-tour

Gitbook plugin to display an interactive tour of a Brooklyn blueprint. You can see a live example [here](https://brooklyn.apache.org/v/1.0.0-SNAPSHOT/start/policies.html)

## Usage

This plugins uses gitbook blocks to create a tour:

```markdown
{% tour %}

{% block title="My **title**", description="My *description* with a [link](http://example.org)" %}
name: example
brooklyn.config:
  foo: bar

...

{% endtour %}
```

### `tour` block

This block wraps all `block` blocks for the tour. There is no configuration for it

### `block` block

This block creates a new blueprint tour block that consist of:

| Config            | Description                                                                                               | required |
| ----------------- | --------------------------------------------------------------------------------------------------------- | -------- |
| title (arg)       | The title of the block. Will be display on the left of the body. Accept markdown syntax                   | Yes      |
| description (arg) | The description of the block. Will be displayed when hovering this specific block. Accept markdown syntax | Yes      |
| body              | This is the code to display for this particular block. Accept HTML and markdown syntax                    | No       |

---
_Source: https://npm.io/package/gitbook-plugin-blueprint-tour · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._