@marmicode/checklist-cli is a CLI that allows you to generate beautiful, dynamic and progress-aware best practices checklist from simple configuration and markdown files.
@marmicode/checklist-cli is based on the source code of Angular Checklist which was brought to us with ❤️ by our amazing friends Dominic Elm and Kwinten Pisman.
We thought that Angular Checklist is so intuitive and useful that it deserved to be adapted to other topics. That's the reason why we came up with this CLI so anyone can make a similar checklist and publish it anywhere without having to fork the app's source code.
The cli converts markdown like this:
---
title: put code samples
---
# Problem
It's hard to explain code without `code`.
# Solution
Write code like this:
\`\`\`ts
const boom = () => setInterval(boom);
boom();
\`\`\`
**WARNING:** THIS WILL EXPLODE 💥into something friendly like this:
-
Create a
contentdirectory (check out the Angular Checklist example here) -
Run the CLI
npx @marmicode/checklist-cli content # where content is the path to your content folder
- Deploy anywhere or start locally using
http-server
npm install -g http-server # or yarn global add http-server
http-server dist/browser
If you want to add file a bug, contribute some code, or improve our documentation, read up on our contributing guidelines and code of conduct, and check out open issues as well as open pull requests to avoid potential conflicts.
|
Co-author of Angular-Checklist
Dominic Elm twitter: @elmd_ |
|
Co-author of Angular-Checklist
Kwinten Pisman twitter: @KwintenP |
|
Author of @marmicode/checklist-cli
Younes Jaaidi twitter: @yjaaidi |