this post was submitted on 24 Aug 2023
2 points (60.0% liked)

Open Source

28934 readers
352 users here now

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

Useful Links

Rules

Related Communities

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

founded 4 years ago
MODERATORS
 

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

top 17 comments
sorted by: hot top controversial new old
[–] [email protected] 18 points 10 months ago* (last edited 10 months ago) (1 children)

Cant you just use your favorite general purpose editor?

[–] [email protected] 1 points 10 months ago

Even if not general purpose, I would think a markdown editor would suffice.

[–] [email protected] 9 points 10 months ago

Don't you mean a markdown editor?

Chances are, your favorite text editor can handle markdown well enough... unless you want WYSIWYG, in which case your text editor would still be good enough for the job and you would be wrong :-)

[–] [email protected] 7 points 10 months ago

More accurately

what’s a good text editor

Literally whatever you want, dude.

[–] [email protected] 5 points 10 months ago (1 children)

Apostrophe. It's beautiful.

[–] [email protected] 4 points 10 months ago

A lot of people seem to have misunderstood the question and are offering text editors. Apostrophe as actually looks like it fits the bill for a decent markdown editor, which is what OP seems to have been asking for

[–] [email protected] 4 points 10 months ago

I use Kate as it opens pretty quickly and I've gotten used to using it to make simple bash scripts

[–] [email protected] 4 points 10 months ago
[–] [email protected] 2 points 10 months ago

I just use whatever text editor I happen to have open - generally that's (neo)vim for me, but I've also used IntelliJ/JetBrains products to do so, along with VSCode on the rare case.

None of them have had the extra features that you mentioned, I don't use emacs but considering its very powerful org-mode I wouldn't be surprised if someone has implemented something similar for Markdown? I haven't specifically seen anything that covers these though (which could just be not looking hard enough, admittedly).

[–] [email protected] 2 points 10 months ago (1 children)

VSCODE with markdown extensions

[–] [email protected] 1 points 10 months ago (1 children)

VS Code's extension system makes it pretty easy to build your own code snippet extension. I use my own private extension to easily "generate" different types of markdown files (ie readme vs a troubleshooting guide) from my personalized snippets.

[–] [email protected] 1 points 10 months ago

Also has an easy way to jump between different markdowns files using the symbols popup menu Ctrl+T

[–] [email protected] 1 points 10 months ago

I guess it depends on what you want to use it for.

If it's knowledge management (to manage your own personal notes), you might want to check out logseq.

[–] [email protected] 1 points 10 months ago

GNU Emacs of course. I am particularly fond of spacemacs, because I like vim keybindings. For git functionality we have the excellent magit package on our side, which makes Emacs also my favorite git interface.

[–] [email protected] 1 points 10 months ago (1 children)
[–] [email protected] 2 points 10 months ago* (last edited 10 months ago)

More like a notes/personal wiki app, than a readme editor.

That said, Obsidian is a diamond in the rough. Building a personal wiki while learning a skill and referencing it later (via search or category) is a true life hack. It feels like augmenting your memory capacity.

Truly invaluable if you need to reference things often but your knowledge base is highly specialized (e.g., I'm a neurology professor)

[–] [email protected] 1 points 10 months ago* (last edited 10 months ago)

Ghostwriter for KDE, Marker for Gnome, Markor for Android