Open Source

31218 readers

110 users here now

All about open source! Feel free to ask questions, and share news, and interesting stuff!

Useful Links

Rules

Posts must be relevant to the open source ideology
No NSFW content
No hate speech, bigotry, etc

Related Communities

Community icon from opensource.org, but we are not affiliated with them.

founded 5 years ago

MODERATORS

[email protected]

What's everyone's favorite README editor? (self.opensource)

submitted 1 year ago* (last edited 1 year ago) by pexavc to c/[email protected]

31 comments fedilink hide all child comments

Looking for a good README editor. With maybe git functionality, but not necessary

Like adding shields/badges/assets within automatically
managing a directory like structure by generating new MD files in a directory like folder structure.

Essentially an IDE like environment just for markdown file management and a WYSIWYG editing experience

you are viewing a single comment's thread
view the rest of the comments

[–] BitSound 2 points 1 year ago

READMEs aren't necessarily markdown. That is the most popular option, but there's others out there. Here's Github's list of supported README formats for example:

The following markups are supported. The dependencies listed are required if you wish to run the library. You can also run script/bootstrap to fetch them all.

.markdown, .mdown, .mkdn, .md -- gem install commonmarker (https://github.com/gjtorikian/commonmarker)

.textile -- gem install RedCloth (https://github.com/jgarber/redcloth)

.rdoc -- gem install rdoc -v 3.6.1

.org -- gem install org-ruby (https://github.com/wallyqs/org-ruby)

.creole -- gem install creole (https://github.com/larsch/creole)

.mediawiki, .wiki -- gem install wikicloth (https://github.com/nricciar/wikicloth)

.rst -- pip install docutils

.asciidoc, .adoc, .asc -- gem install asciidoctor (http://asciidoctor.org)

.pod -- Pod::Simple::XHTML comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.