{"id":13623303,"url":"https://github.com/ridaeh/gitbook-plugin-terminull","last_synced_at":"2025-04-15T14:32:41.929Z","repository":{"id":143880045,"uuid":"231256922","full_name":"ridaeh/gitbook-plugin-terminull","owner":"ridaeh","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 .","archived":false,"fork":false,"pushed_at":"2022-09-04T10:16:09.000Z","size":58,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T21:28:51.047Z","etag":null,"topics":["gitbook","gitbook-plugin","terminal","terminull-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ridaeh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-01-01T19:49:21.000Z","updated_at":"2023-09-28T07:02:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"88232525-0c75-42da-890b-6e55f3e950de","html_url":"https://github.com/ridaeh/gitbook-plugin-terminull","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridaeh%2Fgitbook-plugin-terminull","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridaeh%2Fgitbook-plugin-terminull/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridaeh%2Fgitbook-plugin-terminull/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ridaeh%2Fgitbook-plugin-terminull/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ridaeh","download_url":"https://codeload.github.com/ridaeh/gitbook-plugin-terminull/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681586,"owners_count":21144713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gitbook","gitbook-plugin","terminal","terminull-plugin"],"created_at":"2024-08-01T21:01:30.164Z","updated_at":"2025-04-15T14:32:41.672Z","avatar_url":"https://github.com/ridaeh.png","language":"JavaScript","readme":"\n\u003cdiv align=\"center\"\u003e\n \u003ch1\u003e Terminull \u003c/h1\u003e\n \u003cp\u003eTerminull is a \u003ca href=\"https://www.npmjs.com/package/gitbook\"\u003egitbook\u003c/a\u003e 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 .\u003c/p\u003e\n \u003c/div\u003e\n\u003ca href=\"https://www.npmjs.com/package/gitbook-plugin-terminull\"\u003e\u003cimg  src=\"https://img.shields.io/npm/v/gitbook-plugin-terminull/latest?color=green\" alt=\"npm version\"/\u003e\u003c/a\u003e\n\n ## Themes:\n ### Dark theme\n\n \u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/ridaeh/gitbook-plugin-terminull/master/dark_theme_preview.png\"/\u003e\n\u003c/div\u003e\n\n### Light theme\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/ridaeh/gitbook-plugin-terminull/master/light_theme_preview.png\"/\u003e\n\u003c/div\u003e\n\n## How to use it?\nTo 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`.\n\n```json\n{\n  \"plugins\": [\"terminull\"],\n  \"pluginsConfig\": {\n    \"terminull\": {\n      \"theme\": \"dark\", // use \"light\" for light theme\n      \"copy_button\": \"enabled\" // \"disabled\" to hide the copy button\n    }\n  }\n}\n```\n\n## Create you terminal\n\nTo create a terminal you can use one of two options:\n - Code markdown with `term` as language :\n\u003cpre \u003e\u003ccode\u003e```\u003cstrong style=\"color:green\"\u003eterm\u003c/strong\u003e\nterminull$ echo 'hello terminull' # This will print hello terminull\nhello terminull\n```\n\u003c/code\u003e\u003c/pre\u003e\n\ne.g :\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```\u003cstrong style=\"color:green\"\u003eterm\u003c/strong\u003e\necho 'hello terminull' \n```\n\u003c/code\u003e\u003c/pre\u003e\n\n - Gitbook term tag\n\nEach terminal should have a directory where command is excuted, command and output of the command.\n\n```\n{% term %}\n{% directory %}\n~/gitbook-plugin-terminull\n{% command %}\necho \"Hello terminull\"\n{% comment %}\nThis will print 'Hello terminull' in the screen\n{% output %}\nHello terminull\n{% endterm %}\n```\n\n## You like my work :exclamation:\nIn case you were wondering how you can thanks me for my work, coffee :coffee: is the way to my heart.   \n\n\u003ca href=\"https://www.buymeacoffee.com/ridaeh\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" \u003e\u003c/a\u003e\n\n\n\n## Contributing\nBug reports and pull requests are welcome.\n\n1. Fork it!\n2. Create your feature branch: git checkout -b my-new-feature\n3. Commit your changes: git commit -am 'Add some feature'\n4. Push to the branch: git push origin my-new-feature\n5. Submit a pull request :smile:","funding_links":["https://www.buymeacoffee.com/ridaeh"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fridaeh%2Fgitbook-plugin-terminull","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fridaeh%2Fgitbook-plugin-terminull","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fridaeh%2Fgitbook-plugin-terminull/lists"}