# gitbook-plugin-js-console

> GitBook plugin that provide interactive JavaScript console

Latest version **3.2.0** (published 2024-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install gitbook-plugin-js-console
pnpm add gitbook-plugin-js-console
yarn add gitbook-plugin-js-console
bun add gitbook-plugin-js-console
```

## 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 | 3.2.0 |
| Published | 2024-04-16 |
| First published | 2016-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | azu |
| Maintainers | azu |
| Keywords | gitbook, gitbook-plugin, plugin |

## Links

- npm: https://www.npmjs.com/package/gitbook-plugin-js-console
- Repository: https://github.com/azu/gitbook-plugin-js-console
- Issues: https://github.com/azu/gitbook-plugin-js-console/issues
- npm.io page: https://npm.io/package/gitbook-plugin-js-console

## Dependencies (1)

- [codemirror-console-ui](https://npm.io/package/codemirror-console-ui.md) ^3.2.0

## Recent versions

- 3.2.0 (latest) — 2024-04-16
- 3.1.0 — 2023-06-05
- 3.0.4 — 2022-02-06
- 3.0.3 — 2022-02-06
- 3.0.2 — 2022-01-03
- 3.0.1 — 2022-01-03
- 3.0.0 — 2022-01-03
- 2.0.5 — 2019-05-05
- 2.0.4 — 2019-03-16
- 2.0.3 — 2018-12-30
- 2.0.2 — 2018-12-30
- 2.0.1 — 2018-12-29
- 2.0.0 — 2018-12-27
- 1.4.2 — 2018-01-04
- 1.4.1 — 2018-01-02
- … 7 more at https://npm.io/package/gitbook-plugin-js-console/versions

## README

# gitbook-plugin-js-console

GitBook plugin that provide interactive JavaScript console.

Dependencies:

- [codemirror-console-ui](../codemirror-console-ui)

## Install

Install with [npm](https://www.npmjs.com/):

    npm install gitbook-plugin-js-console

## Usage

put "js-console" to your `book.json`

```json
{
  "gitbook": ">=3.0.0",
  "plugins": [
    "js-console"
  ]
}
```

Add `<!-- js-console -->` or `class="gitbook-plugin-js-console"` node before/after of CodeBlock.

    <!-- js-console -->
    ```js
    1 + 2;
    ```

Add `<!-- js-console:{ "state": "open" } -->` and this console is opened by default.

    <!-- js-console:{ "state": "open" } -->
    ```js
    1 + 2;
    ```

Add `<!-- js-console:{ "type": "module" } -->` and this console will execute the code as ECMAScript Module.

:memo: Current limitation: ES Modules mode does not return value

    <!-- js-console:{ "type": "module" } -->
    ```js
    await 1; // Module allow Top-Level await
    ```

For more details, See [website](../../website/).

## Changelog

See [Releases page](https://github.com/azu/gitbook-plugin-js-console/releases).

## Running tests

Install devDependencies and Run `npm test`:

    npm i -d && npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/azu/gitbook-plugin-js-console/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)

## License

MIT © azu

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