1.1.0 • Published 2 years ago

gitbook-plugin-terminull v1.1.0

Weekly downloads
2
License
ISC
Repository
github
Last release
2 years ago

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.

{
  "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 :
</code></pre>

e.g :
<pre lang="no-highlight"><code>```<strong style="color:green">term</strong>
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: