convert README to Markdown before publishing package #411
Conversation
mojavelinux
commented
Jan 17, 2018
mojavelinux
commented
- move AsciiDoc README to the side
- convert AsciiDoc README to Markdown
- allow pack to include README.md in package
- restore AsciiDoc README after publishing
- move AsciiDoc README to the side - convert AsciiDoc README to Markdown - allow pack to include README.md in package - restore AsciiDoc README after publishing
mojavelinux
force-pushed
the
readme-dance
branch
from
f47a432
to
eb22581
Compare
|
This will restore the README on npmjs. It will also improve the appearance of the README. We're still using some Markdown formatting in the README, but that just makes it a little easier to convert. |
|
While we continue to lobby for AsciiDoc support on npm, we at least want to have something to display. You can see an example here: https://www.npmjs.com/package/bespoke-overview |
|
|
||
| const RefMacroRx = new RegExp('(image:)?(?:(https?:[^\\[]+)|\{([a-z0-9_-]+)\})\\[(|.*?[^\\\\])\\]', 'g'); | ||
|
|
||
| function markdownify (asciidoc) { |
There was a problem hiding this comment.
It's clever, I think we should share this code as part of a library 😉
There was a problem hiding this comment.
I agree. That would avoid a lot of copy-paste between projects. My only hesitation is that this kind of a quick hack, so putting it on npm might give people the impression that it's a general purpose converter. I suppose we could name it accordingly.
This converter is more comprehensive than the one I used for bespoke-overview since this README is more advanced.
There was a problem hiding this comment.
My only hesitation is that this kind of a quick hack, so putting it on npm might give people the impression that it's a general purpose converter. I suppose we could name it accordingly.
I had thought about it but as you said we can name it accordingly and state in the README that this converter is not a general purpose converter. But still I think it can be very useful 👍
|
Looking forward to see it in action! |
|
The README is (finally) looking gorgeous on npmjs 🎉 🎉 🎉 Thanks @mojavelinux 😄 |
