walkthru
This is part of a set of tools designed to verify that code walkthroughs work correctly. The need arised when I wrote a step by step code walkthrough. I created the instructions based on a finished repository, but it was hard to verify that all the steps
Last updated 2 years ago by eljuli .
MIT · Original npm · Tarball · package.json
$ cnpm install walkthru -g
SYNC missed versions from official npm registry.

Walkthru

This is part of a set of tools designed to verify that code walkthroughs work correctly. The need arised when I wrote a step by step code walkthrough. I created the instructions based on a finished repository, but it was hard to verify that all the steps worked correctly. I could also have missed some steps, but I would need to follow all instructions step by step to make sure they work fine.

Walkthru solves this problem. It lets you verify that all steps in a markdown file work correctly. It transforms shell commands and code snippets from a markdown file into a shell script. To verify that your walkthrough is correct, you just need to run walkthru input.md output.sh and run the generated shell script.

Note that by itself, walkthru is just a tool that generates a shell script based on commands in a markdown file. It's entirely up to you to write the commands in a way that lets you verify that they work correctly. I recommend that you run your script in a Docker container so that it starts from scratch every time. You can see an example in fixtures folder. To try it out, run ./shell.sh to start a shell session in the container. Then run ./walkthrough.sh inside it, wait for it to finish, and finally go to http://localhost:3000. You should see the final step of the walkthrugh working.

## Installation

yarn global add walkthru or npm install -g walkthru

## Usage

walkthru input.md output.sh

Current Tags

  • 1.0.0                                ...           latest (2 years ago)

1 Versions

  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (3)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |