Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/endel/tutomd
📄 Tool that generates good-looking and structured tutorials with Markdown
https://github.com/endel/tutomd
generator markdown markdown-to-html tutorial
Last synced: 14 days ago
JSON representation
📄 Tool that generates good-looking and structured tutorials with Markdown
- Host: GitHub
- URL: https://github.com/endel/tutomd
- Owner: endel
- License: mit
- Created: 2022-01-05T14:44:03.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-22T18:11:26.000Z (over 2 years ago)
- Last Synced: 2024-08-01T22:04:38.949Z (4 months ago)
- Topics: generator, markdown, markdown-to-html, tutorial
- Language: CSS
- Homepage: https://endel.dev/tutomd/
- Size: 1.81 MB
- Stars: 17
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Structured Tutorial Generator (using Markdown)
> The output of `tutomd` is highly inspired by Unity Learn tutorials (see [an example](https://learn.unity.com/project/introduction-to-visual-scripting?uv=2021.1))
**[See live demo generated by `tutomd` 🐶](https://endel.dev/tutomd/)**
## Features
- Friendly and intuitive to navigate 💅 (Looks good on mobile, too!)
- **h1** are the section separators
- first **h1** is the page summary
- following **h1** are section "steps", with completion status
- Each `.md` file input is treated as a big step on the sidebar.
- Sidebar contains all "steps" titles from all files
- Metadata support through `---` block at the beginning of the file.
## Installation and usage
```
npm install -g tutomd
```
Generating the HTML output:
```
tutomd tutorial/ --out html
Copying from tutorial/4-directory-structure.png to /Users/endel/Projects/endel.dev/tutomd/4-directory-structure.png
Copying from tutorial/head.html to /Users/endel/Projects/endel.dev/tutomd/head.html
Copying from tutorial/tutomd.png to /Users/endel/Projects/endel.dev/tutomd/tutomd.png
Write /Users/endel/Projects/endel.dev/tutomd/index.html
Write /Users/endel/Projects/endel.dev/tutomd/1-what-to-expect.html
Write /Users/endel/Projects/endel.dev/tutomd/2-installing-tutomd.html
Write /Users/endel/Projects/endel.dev/tutomd/3-markdown-essentials.html
Write /Users/endel/Projects/endel.dev/tutomd/4-structure-guide-and-formatting-rules.html
Write /Users/endel/Projects/endel.dev/tutomd/theme.css
```
You can find the sources of the live demo at [tutorial/](https://github.com/endel/tutomd/tree/master/tutorial) directory.
## Hey, I made this on stream!
Follow me on Twitch 😋 [https://www.twitch.tv/endeld](https://www.twitch.tv/endeld)
## License
MIT.