Comments (6)
There is run-markdown
That does something similar. In its current state it is not well usable because you can't prepare an environment for the test. (specify code that you don't need to be visible within the markdown file). But I think think in general it is good practise - I don't know how often I published broken docs ...
from standard-readme.
This would have to be a suggestion, as some code can't easily be run in a REPL. We could suggest run-markdown. Or others?
from standard-readme.
If there is a linter, it should include a way to pass the code snippets to an executor: i.e. if there is a
console.log('Hello')
and you run the readme against standard-readme --exec="npm run test-doc"
and it will execute the above snippet like:
$ echo "console.log('Hello')" | npm run test-doc -- 1
from standard-readme.
Agreed about this is something that ought to be worked into the linter. Going to link it to #5 and leave this open for now.
from standard-readme.
Is this something standard-readme can dictate? π€ Iβd leave this up to platforms that render readmes!
from standard-readme.
Agreed.
from standard-readme.
Related Issues (20)
- Improvement in License section HOT 1
- Question on Usage section HOT 1
- Question: clarifying on rules for install, usage, and contributing HOT 3
- Installation fails because of missing dependency to opencollective-postinstall HOT 1
- README.cn.md doesn't follow naming convention HOT 8
- Introduce REUSE compliance/compatibility HOT 1
- ζ¨ε₯½οΌθ½εδΈδΈͺζ°ζθ½ηζηζη¨εοΌ
- cat: spec.md: No such file or directory HOT 1
- README, Markdown and other formats HOT 1
- It's a good markdown file HOT 1
- Create a logo for Open Collective
- The "Install" section may not seem right for deployable websites HOT 2
- Does this project comply with standard-readme HOT 1
- Table of Contents Built in to GitHub HOT 2
- Demo
- Some links in the maximal example are broken HOT 4
- Add support for CHANGELOG.md? HOT 2
- Add a Credits/Thanks/Acknowledgements section HOT 6
- Examples use "contributing" which results in an error HOT 3
- Chinese translation HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from standard-readme.