feat(docs): add flag for building markdown docs #173
Conversation
ghost
requested a review
from 
Codecov Report
@@ Coverage Diff @@
## master #173 +/- ##
=======================================
Coverage 77.77% 77.77%
=======================================
Files 6 6
Lines 135 135
=======================================
Hits 105 105
Misses 30 30Continue to review full report at Codecov.
|
ghost
self-assigned this
There was a problem hiding this comment.
Thank you @lgierth
It would be nice to make the flags not either or though. Maybe we could have a format flag which is by default set to html but is an array so you have all three options
--format html--format md--format html,md
cmds/docs.js
Outdated
| @@ -11,6 +11,11 @@ module.exports = { | |||
| alias: 'p', | |||
| describe: 'Publish to GitHub Pages', | |||
| default: false | |||
| }, | |||
| markdown: { | |||
There was a problem hiding this comment.
This flag should also be present on the release command, as it generates docs as well.
src/docs/build.js
Outdated
| const docsPath = utils.getPathToDocs() | ||
| return fs.ensureDir(docsPath) | ||
| .then(() => { | ||
| fs.writeFileSync(docsPath + '/index.md', output) |
There was a problem hiding this comment.
please use path.join(docsPath, 'index.md') to ensure the path is usable on all oses
|
Hope I addressed all your points -- my JS is a bit rusty :) Renamed the flag to I didn't figure out how to test |
|
I'm gonna call the windows node8 failure unrelated: |
Look what I made \o/
This is for ipfs-inactive/docs#43