4 ms·
> Some basic requirements are: - searchable - code snippets - hyperlinking I think another requirement to add is diagramming. I think wiki-style diagramming w
by epage 8y ago
> Some basic requirements are: - searchable - code snippets - hyperlinking
I think another requirement to add is diagramming. I think wiki-style diagramming would be a big help for programmers to better communicate ideas.
I've used external tools like draw.io but the overhead for editing, downloading, and uploading I feel gets in the way. Sadly, we are on confluence but don't use the draw.io plugin [1]. Built-in support for dot, uml, or even ascii diagrams [2] would be big help.
[1] https://about.draw.io/integrations/confluence-integration-2/ https://about.draw.io/integrations/confluence-integration-2/
[2] e.g. https://github.com/ivanceras/svgbob https://github.com/ivanceras/svgbob
- harlanji 8y agoI like Dia enough, but lately InkScape is what’s up. Both use file formats that could be generated from source as part of the build, as well.
- aasasd 8y agoMermaid is a “Markdown for diagrams” that seems to use a more semantic markup instead of ASCII art: https://github.com/knsv/mermaid https://github.com/knsv/mermaid Would probably work nice as a plugin for a wiki.
- Ninjaneered 8y agoI've been using Mermaid with MediaWiki and it has a lot of promise. Since Mermaid lets me generate diagrams from text and MediaWiki lets me store and modify structured data, I can have MediaWiki pass Mermaid data to generate graphs/diagrams that stay up-to-date as the wiki changes. I would like to see Mermaid be able to group sibling nodes[0] though, once I can do that, I can autocreate really nice organizational charts :) [0] https://github.com/knsv/mermaid/issues/637 https://github.com/knsv/mermaid/issues/637
- marton78 8y agoThe PlantUML plugin for confluence is free and works great for us.