{"id":22174984,"url":"https://github.com/morningspace/termitorial","last_synced_at":"2025-03-24T18:18:50.252Z","repository":{"id":103642818,"uuid":"259320235","full_name":"morningspace/termitorial","owner":"morningspace","description":"A script that allows you to organize your tutorial in multiple lessons using a hierarchical structure where each lesson is written as a Markdown file, then run interactively in a terminal.","archived":false,"fork":false,"pushed_at":"2021-07-03T15:10:32.000Z","size":59,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-29T22:46:55.483Z","etag":null,"topics":["interactive","markdown","shell","terminal","tutorial"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/morningspace.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-27T12:58:45.000Z","updated_at":"2021-07-12T09:26:44.000Z","dependencies_parsed_at":"2023-05-24T04:45:43.151Z","dependency_job_id":null,"html_url":"https://github.com/morningspace/termitorial","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morningspace%2Ftermitorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morningspace%2Ftermitorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morningspace%2Ftermitorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morningspace%2Ftermitorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/morningspace","download_url":"https://codeload.github.com/morningspace/termitorial/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245325220,"owners_count":20596818,"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":["interactive","markdown","shell","terminal","tutorial"],"created_at":"2024-12-02T07:55:41.765Z","updated_at":"2025-03-24T18:18:50.226Z","avatar_url":"https://github.com/morningspace.png","language":"Shell","readme":"# TermiTorial\n\nTermiTorial, the abbreviation form of Terminal Tutorial, is a script that allows you to organize your tutorial as multiple lessons using a hierarchical structure where each lesson is written as a Markdown file. The tutorial can not only be viewed as online documents, but also can be run interactively in a terminal. TermiTorial is driven by [demo-magic](https://github.com/paxtonhare/demo-magic) under the hood.\n\nTo learn more on the use of TermiTorial, please check [The TermiTorial Tutorial: Make Markdown Executable](docs/README.md).\n\n## How to Install?\n\nIt is easy to install TermiTorial. You can git clone it from this GitHub repository, then make termitorial.sh executable as below:\n```shell\ngit clone https://github.com/morningspace/termitorial.git\ncd termitorial\nchmod +x termitorial.sh\n```\n\nTo run TermiTorial at any place, you can place the script anywhere in your `PATH`. For example:\n```shell\nln -s $PWD/termitorial.sh /usr/local/bin/termitorial\n```\n\nYou may now invoke TermiTorial at any place:\n```shell\ntermitorial -h\n```\n\n## How to Run?\n\nTo launch a tutorial using TermiTorial, make sure you are in the tutorial root directory. Then run TermiTorial.\n\nYou can run the whole tutorial as below:\n```\ntermitorial\n```\n\nYou can also choose a specific lesson by appending the path to the lesson when run the script. The lesson file extension `.md` can be comitted. For example:\n```\ntermitorial features/basics\n```\n\nTo list all lessons available to the tutorial, you can run below command:\n```\ntermitorial -l\n```\n\n## The TermiTorial Tutorial\n\n[The TermiTorial Tutorial: Make Markdown Executable](docs/README.md) is a tutorial that can walk you through all features provided by TermiTorial. It is organized using a hierarchical structure with a set of Markdown files which can be viewed online, meanwhile can be launced from the command line by TermiTorial itself.\n\nYou can go into the tutorial root directory `docs`, then launch the tutorial using TermiTorial.\n\n\u003e To learn TermiTorial by TermiTorial itself.\n\nHope you enjoy it!","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorningspace%2Ftermitorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorningspace%2Ftermitorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorningspace%2Ftermitorial/lists"}