# docsify-terminal-block

> [![](https://data.jsdelivr.com/v1/package/npm/docsify-terminal-block/badge)](https://www.jsdelivr.com/package/npm/docsify-terminal-block)

Latest version **1.0.3** (published 2023-04-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install docsify-terminal-block
pnpm add docsify-terminal-block
yarn add docsify-terminal-block
bun add docsify-terminal-block
```

## 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.3 |
| Published | 2023-04-14 |
| First published | 2023-04-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Maintainers | dolanmiu |

## Links

- npm: https://www.npmjs.com/package/docsify-terminal-block
- Repository: https://github.com/dolanmiu/docsify-terminal-block
- Issues: https://github.com/dolanmiu/docsify-terminal-block/issues
- npm.io page: https://npm.io/package/docsify-terminal-block

## Dependencies (1)

- [daisyui](https://npm.io/package/daisyui.md) ^2.51.4

## Recent versions

- 1.0.3 (latest) — 2023-04-14
- 1.0.2 — 2023-04-12
- 1.0.1 — 2023-04-12
- 1.0.0 — 2023-04-12

## README

# docsify-terminal-block 🖥️

[![](https://data.jsdelivr.com/v1/package/npm/docsify-terminal-block/badge)](https://www.jsdelivr.com/package/npm/docsify-terminal-block)

A docsify plugin to add pretty terminal blocks to your docs. It has `Copy to Clipboard` functionality too.

## Screenshots

![Example](https://i.imgur.com/IZdOtLh.png)

## Installation

Add the docsify-terminal-block plugin to your index.html after docsify. The plugin is available on jsdelivr (below), unpkg, and other CDN services that auto-publish npm packages.

```html
<script src="https://cdn.jsdelivr.net/npm/docsify-terminal-block@1.0.2"></script>
```

## Usage

Add the `terminal` tag to your markdown file to create a terminal block.

````

    ```terminal
    npm run start
    ```
````

You can add prefixes to the terminal block to change the style of the line. For example adding `$` or `>`:

````

    ```terminal
    $|npm run start
    >|npm run start
    ```
````

You can make the line a warning, info, error, or success by adding `warning`, `info`, `error`, or `success` after the prefix:

````

    ```terminal
    $|warning|npm run build
    >|info|npm run start
    >|error|npm run start
    >|success|npm run start
    ```
````

## Example

````

    ```terminal
    npm run start
    $|npm run start
    $|warning|npm run build
    >|info|npm run start
     |...
    >|error|npm run start
    >|success|npm run start

    warning|npm run build
    ```
````

---

Made with ❤️

---
_Source: https://npm.io/package/docsify-terminal-block · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._