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 must log in or register to comment.
Cant you just use your favorite general purpose editor?
Even if not general purpose, I would think a markdown editor would suffice.
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 :-)
More accurately
what’s a good text editor
Literally whatever you want, dude.
Apostrophe. It’s beautiful.
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
Emacs.
I use Kate as it opens pretty quickly and I’ve gotten used to using it to make simple bash scripts
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).
VSCODE with markdown extensions
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.
Also has an easy way to jump between different markdowns files using the symbols popup menu Ctrl+T
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.
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.
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)
Ghostwriter for KDE, Marker for Gnome, Markor for Android
