Skip to content

Commit 5de3fa7

Browse files
committed
update description
1 parent 1af3a73 commit 5de3fa7

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,22 @@ To use Terminull plugin in your Gitbook project, add the terminull plugin to the
2121

2222
## Create you terminal
2323

24-
First, you need to create a terminal. Each terminal should have a directory where command is excuted, command and output of the command.
24+
To create a terminal you can use one of this options:
25+
- Code markdown with `term` as language :
26+
<pre ><code>```<strong style="color:green">term</strong>
27+
gitbook-plugin-terminull$ echo 'hello terminull' # This will print hello terminull
28+
hello terminull
29+
```
30+
</code></pre>
31+
32+
e.g :
33+
<pre lang="no-highlight"><code>```<strong style="color:green">term</strong>
34+
echo 'hello terminull'
35+
```
36+
</code></pre>
37+
- Gitbook term tag
38+
39+
Each terminal should have a directory where command is excuted, command and output of the command.
2540

2641
```
2742
{% term %}

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "gitbook-plugin-terminull",
3-
"version": "1.0.4",
4-
"description": "Gitbook modern terminal",
3+
"version": "1.0.5",
4+
"description": "🦄 Terminull is a gitbook plugin allows you to create a modern terminal for your gitbook pages in order to documente your commands and it gives you a fast way to copy the command .",
55
"main": "index.js",
66
"repository": {
77
"type": "git",

0 commit comments

Comments
 (0)