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
    231·
    2 years ago

    Cant you just use your favorite general purpose editor?

    • pexavc@lemmy.worldOP
      51·
      2 years 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
          3·
          2 years 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
    15·
    2 years 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 :-)

    • pexavc@lemmy.worldOP
      1·
      2 years 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
        1·
        2 years 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/…

    • BitSound@lemmy.world
      21·
      2 years 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.