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

  • auth@lemmy.ml
    link
    fedilink
    arrow-up
    39
    arrow-down
    1
    ·
    edit-2
    1 year ago

    Cant you just use your favorite general purpose editor?

    • pexavc@lemmy.worldOP
      link
      fedilink
      arrow-up
      5
      arrow-down
      2
      ·
      edit-2
      1 year ago

      I could have posed the question better. But, I haven’t found one that served my needs yet. Nor do I not know of one that may have interesting features that would make it easier to do things, like maybe adding shields/badges/assets within automatically or being able to create a directory like structure by generating new MD files when wanting to create a comprehensive API doc.

        • pexavc@lemmy.worldOP
          link
          fedilink
          arrow-up
          3
          ·
          edit-2
          1 year ago

          Updated the comment with an example.

          maybe adding shields/badges/assets within automatically, through a GUI or being able to create a directory like structure by generating new MD files when wanting to create a comprehensive API doc.

          I do not clearly know as well and wanted to just get an understanding of what everyone uses and be aware at least that such software exists if they use something with more advanced features over a natural text editing environment

  • gomp@lemmy.ml
    link
    fedilink
    arrow-up
    24
    ·
    1 year 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 :-)

    • BitSound@lemmy.world
      link
      fedilink
      arrow-up
      3
      arrow-down
      1
      ·
      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.

    • pexavc@lemmy.worldOP
      link
      fedilink
      arrow-up
      1
      ·
      1 year ago

      Yeah, have been using text editor mainly for markdown editing or other lightweight WYSIWYG apps, it’s good enough. Felt, there could be more out there that I am missing out on which I am unaware of.

      • gomp@lemmy.ml
        link
        fedilink
        arrow-up
        2
        ·
        1 year ago

        There are a pletora of markown editors that have a split view w/ live preview (I used various - the one I currently have installed is Ghostwriter), but you can most probably get the same with your programmer’s text editor (well, unless your text editing is done in the terminal) and, one way or another, you are not guaranteed that what you see is what will be displayed in github/gitlab/…

  • django
    link
    fedilink
    arrow-up
    7
    ·
    1 year 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.

    • BananaTrifleViolin@kbin.social
      link
      fedilink
      arrow-up
      4
      ·
      1 year 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

  • lckdscl [they/them]@whiskers.bim.boats
    link
    fedilink
    English
    arrow-up
    5
    ·
    1 year ago

    Any text editor that can edit markdown files with syntax highlighting? What kind of git functionality do you want? If you want to see the formatting in place as you edit, look for a WYSIWYG editor (Ghostwriter and Typora come to mind). I use Neovim and have lazygit opened in another terminal tab.

  • orizuru@lemmy.sdf.org
    link
    fedilink
    arrow-up
    3
    ·
    1 year 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.

  • russjr08@outpost.zeuslink.net
    link
    fedilink
    English
    arrow-up
    3
    ·
    1 year 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).

    • Dr Cog@mander.xyz
      link
      fedilink
      arrow-up
      2
      ·
      edit-2
      1 year 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)