https://github.com/morningspace/termitorial
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.
https://github.com/morningspace/termitorial
interactive markdown shell terminal tutorial
Last synced: 11 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/morningspace/termitorial
- Owner: morningspace
- License: mit
- Created: 2020-04-27T12:58:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-03T15:10:32.000Z (over 4 years ago)
- Last Synced: 2025-01-29T22:46:55.483Z (about 1 year ago)
- Topics: interactive, markdown, shell, terminal, tutorial
- Language: Shell
- Homepage:
- Size: 57.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TermiTorial
TermiTorial, 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.
To learn more on the use of TermiTorial, please check [The TermiTorial Tutorial: Make Markdown Executable](docs/README.md).
## How to Install?
It is easy to install TermiTorial. You can git clone it from this GitHub repository, then make termitorial.sh executable as below:
```shell
git clone https://github.com/morningspace/termitorial.git
cd termitorial
chmod +x termitorial.sh
```
To run TermiTorial at any place, you can place the script anywhere in your `PATH`. For example:
```shell
ln -s $PWD/termitorial.sh /usr/local/bin/termitorial
```
You may now invoke TermiTorial at any place:
```shell
termitorial -h
```
## How to Run?
To launch a tutorial using TermiTorial, make sure you are in the tutorial root directory. Then run TermiTorial.
You can run the whole tutorial as below:
```
termitorial
```
You 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:
```
termitorial features/basics
```
To list all lessons available to the tutorial, you can run below command:
```
termitorial -l
```
## The TermiTorial Tutorial
[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.
You can go into the tutorial root directory `docs`, then launch the tutorial using TermiTorial.
> To learn TermiTorial by TermiTorial itself.
Hope you enjoy it!