https://github.com/ridaeh/gitbook-plugin-terminull

🦄 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 .
https://github.com/ridaeh/gitbook-plugin-terminull

gitbook gitbook-plugin terminal terminull-plugin

Last synced: 2 months ago
JSON representation

🦄 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 .

• Host: GitHub
• URL: https://github.com/ridaeh/gitbook-plugin-terminull
• Owner: ridaeh
• Created: 2020-01-01T19:49:21.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-04T10:16:09.000Z (over 2 years ago)
• Last Synced: 2024-10-03T15:08:26.096Z (3 months ago)
• Topics: gitbook, gitbook-plugin, terminal, terminull-plugin
• Language: JavaScript
• Homepage:
• Size: 56.6 KB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - ridaeh/gitbook-plugin-terminull - 🦄 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 . (JavaScript)

README

        



 
 Terminull 

 
Terminull is a gitbook plugin allows you to create a modern terminal for your gitbook pages it helps documente your commands and gives you a fast way to copy the command .

 



 ## Themes:

 ### Dark theme

 


  



### Light theme



  



## How to use it?

To use Terminull plugin in your Gitbook project, add the terminull plugin to the `book.json` file of your project, then install plugins using `gitbook install`.

```json

{

  "plugins": ["terminull"],

  "pluginsConfig": {

    "terminull": {

      "theme": "dark", // use "light" for light theme

      "copy_button": "enabled" // "disabled" to hide the copy button

    }

  }

}

```

## Create you terminal

To create a terminal you can use one of two options:

 - Code markdown with `term` as language :

```term

terminull$ echo 'hello terminull' # This will print hello terminull

hello terminull

```



e.g :

```term

echo 'hello terminull' 

```



 - Gitbook term tag

Each terminal should have a directory where command is excuted, command and output of the command.

```

{% term %}

{% directory %}

~/gitbook-plugin-terminull

{% command %}

echo "Hello terminull"

{% comment %}

This will print 'Hello terminull' in the screen

{% output %}

Hello terminull

{% endterm %}

```

## You like my work :exclamation:

In case you were wondering how you can thanks me for my work, coffee :coffee: is the way to my heart.   



## Contributing

Bug reports and pull requests are welcome.

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 :smile: