wyriwyd / wyriwyd Goto Github PK
View Code? Open in Web Editor NEWCreate and test markdown documentation for your command line tool
License: BSD 3-Clause "New" or "Revised" License
Create and test markdown documentation for your command line tool
License: BSD 3-Clause "New" or "Revised" License
The command the user runs and wants to document, might request input from the user. Have to accommodate this!
The executor module maintains a bash shell and sends commands in, capturing each command's output. Since it's the same shell if you change directory and modify environment variables this is all available to the next commands. Perhaps the wizard's code could make use of this, but adding a command-line reader which sends the commands it receives to the executor and prints what the executor produces back out.
Not quite working yet...
Also need to deal with special characters at the end of output lines.
Extend the testing tool by having it run a markdown file and insert each command blocks output into an output block. If one exists, it should be replaced, if nothing exists it should be created (or perhaps optionally ommitted, if that's what the user intended originally). Makes the testing tool even more like an org-mode / notebook tool for markdown and bash, and useful as a way to update docs automatically when a command has been changed.
Improve open-access by helping people to cite this package.
As the code is structured at the moment the program will hang if trying to cat a file without an ending blank line.
Would be good to auto-deploy this from the CI pipeline.
Currently, the tool doesn't deal with programs writing to stderr
The tutorial material generated, should not depend on resources (mainly input files) not in the repo. This would make the tutorial useless for a user of the package, and will (correctly) fail the wyriwyd tests.
How to fix:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.