https://github.com/dolanmiu/docsify-terminal-block
https://github.com/dolanmiu/docsify-terminal-block
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dolanmiu/docsify-terminal-block
- Owner: dolanmiu
- Created: 2023-03-30T19:24:09.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-15T03:31:54.000Z (almost 3 years ago)
- Last Synced: 2025-03-31T09:41:14.145Z (11 months ago)
- Language: TypeScript
- Size: 349 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-docsify - docsify-terminal-block - A docsify plugin to add pretty terminal code blocks 🖥️ to your docs. It has `Copy to Clipboard` functionality too. (Plugins)
README
# docsify-terminal-block 🖥️
[](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
## 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
```
## 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 ❤️