use markdown-magic for processing documentation #3597
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boneskull
commented
Dec 5, 2018
| @@ -93,7 +93,7 @@ or as a development dependency for your project: | |||
| $ npm install --save-dev mocha | |||
| ``` | |||
|
|
|||
| > Mocha currently requires Node.js v6.x or newer. | |||
| > As of v6.0.0, Mocha requires Node.js v6.0.0 or newer. | |||
There was a problem hiding this comment.
this reminds me; we really need to not publish the site on commits to master. I have no idea how to do that
boneskull
commented
Dec 5, 2018
| const path = require('path'); | ||
|
|
||
| exports.transforms = { | ||
| usage: (content, options) => { |
There was a problem hiding this comment.
I could probably extract this into its own plugin.
boneskull
force-pushed
the
refactor/markdown-magic
branch
from
f8e5a4a
to
df3ebfd
Compare
boneskull
added
semver-patch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sorry about the churn here, as I recently updated these scripts.
I happened across markdown-magic which looked like an easier way to do the stuff we're doing to transform
docs/index.md.markdown-magicfor preprocessingscripts/markdown-magic.config.jswith transformspackage-scripts.jsscripts/preprocess-docs.jscommon-tagsdepmississippidepthrough2depmarkdown-magic-package-jsonto easily dump stuff frompackage.jsoninto the document; added an example of this at the end ofdocs/index.mdwith thegitterpropertyAlso, @plroebuck, whatever was causing the indents in the usage output to not appear stopped happening; the indents are back!