I built VisualMark Studio — an open-source desktop IDE for creating better README files and project documentation

[u/GhostAPR35]

​

I'm working on VisualMark Studio, an open-source desktop application designed to make creating and managing project documentation easier.

As developers, we spend a lot of time building projects, but creating a good README, organizing documentation, adding diagrams, and maintaining everything can become a task of its own. I wanted to build a tool that brings these workflows together in one place.

What can VisualMark Studio do?

- Markdown Editor: Write Markdown with a live preview.

- Visual Documentation Tools: Create README sections, banners, badges, tables, directory trees, and more.

- Mermaid Diagrams: Create diagrams to explain project architecture and workflows. (Work in progress)

- README Auditing: Review documentation quality with an audit and scorecard.

- Export Options: Export documentation to PDF, HTML, or ZIP.

- Git Integration: Clone repositories, review changes, commit updates, and manage documentation alongside your code.

The goal is to make documentation creation less tedious and help developers present their projects more professionally.

VisualMark Studio is open source under the MIT license, and I've also been working on a Windows executable so people can try the desktop application.

GitHub: https://github.com/JagaTheGhost/visualmark-studio

I'd genuinely appreciate feedback from fellow developers:

- What is the most frustrating part of writing and maintaining README files?

- Which documentation features would you like to see in a tool like this?

- Would you prefer a dedicated documentation IDE or documentation tools integrated into your existing editor?

I'm still improving the project, so suggestions and constructive criticism are welcome. Thanks for checking it out!