Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use runmd to build README #204

Merged
merged 7 commits into from
Jun 29, 2017
Merged

Use runmd to build README #204

merged 7 commits into from
Jun 29, 2017

Conversation

broofa
Copy link
Member

@broofa broofa commented Jun 23, 2017

https://github.com/broofa/runmd is a new module I've been working on that allows you to evaluate JS code blocks in README (and other markdown) files. Benefits of this:

  1. Hooking it into the publish process (via npm 'prepare' script hook) acts as a unit test of sorts. Publish doesn't happen if the README file can't be built, so there's incentive to insure the README file is kept current.
  2. It can automatically inject expression results into the markdown, which makes including expected output in docs easier
  3. It forces authors to write code that is accurate and runnable instead of copy/pasting/guessing (cough not that I've ever done that.)

Thoughts?

README.md Outdated
```

### Version 5

```javascript
const uuidv5 = require('uuid/v4');
var uuidv5 = require('uuid/v4');

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to aslo fix the /v4 part of this line as well

@broofa broofa force-pushed the runmd branch 2 times, most recently from 7cac3f1 to e62dc3e Compare June 27, 2017 16:03
Copy link
Collaborator

@defunctzombie defunctzombie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, why not tho I am a bit sad of the use of var over const in the README now.

@broofa broofa merged commit 962c80a into master Jun 29, 2017
@broofa broofa deleted the runmd branch September 7, 2017 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants