1.0.7 • Published 2 years ago
tutomd v1.0.7
Structured Tutorial Generator (using Markdown)
The output of
tutomd
is highly inspired by Unity Learn tutorials (see an example)
See live demo generated by 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/ directory.
Hey, I made this on stream!
Follow me on Twitch 😋 https://www.twitch.tv/endeld
License
MIT.
1.0.7
2 years ago
1.0.6
2 years ago
1.0.5
2 years ago
1.0.4
2 years ago
1.0.3
2 years ago
1.0.2
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago
0.9.17
2 years ago
0.9.16
2 years ago
0.9.14
2 years ago
0.9.13
2 years ago
0.9.12
2 years ago
0.9.11
2 years ago
0.9.10
2 years ago
0.9.9
2 years ago
0.9.8
2 years ago
0.9.7
2 years ago
0.9.6
2 years ago
0.9.5
2 years ago
0.9.4
2 years ago
0.9.3
2 years ago
0.9.2
2 years ago
0.9.1
2 years ago
0.9.0
2 years ago
0.1.1
2 years ago
0.1.0
2 years ago