3 ms·
Hi HN, Imagine that you guys want to write documentation for your project by writing Markdown in Readme.md, to be published on GitHub later. I'm an Android De
by kukuhsain 8y ago
Hi HN,
Imagine that you guys want to write documentation for your project by writing Markdown in Readme.md, to be published on GitHub later.
I'm an Android Dev, and I use a plugin to preview my Readme in Android Studio. And sometimes, I use other online Markdown editor, by doing live editing there. Problem solved, at least for now.
What I've found so far is that those solutions give me different style. And the problem usually arises after that. Sometimes, after updating the Readme.md file and push it to GitHub, there are some parts that are not suitable. Something like, H1 is too bigger for this section, or link is not shown well there, etc.
Devpen is an online tool to solve that problem.
- pravj 8y agoNeat and clean. Bookmarked, will give a try next time I write markdown for GitHub. You are correct about the incompatible markdown styles on the Internet.
- ngnh 8y agoMight be a neat idea to preview the actual editor on your landing page instead of a screen shot.
- kukuhsain 8y agoGood idea! Thanks for the feedback.
- nfriend 8y agoVery cool - I've run into the exact problem you described many times in the past and actually considered building something very similar to this. As a side note, it looks like <img>'s aren't working - try adding something like this: <img src="https://www.google.ca/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png" /> Making images format correctly in GitHub READMEs has always been a bit of a pain point for me, so this would be a nice feature to have.
- kukuhsain 8y agoOh yes, good catch. Thanks for the feedback.
- piracyde25 8y agoThis and generally other HTML tag codes aren't supported atm. Otherwise, it looks clean I like it :)
- kukuhsain 8y agoHi, I've updated Devpen.io, and now it supports img tag, and html tag generally. You can try yourself there :)