TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Show HN: Software Documentation Using GitHub

6 pointsby valehelleover 5 years ago

1 comment

valehelleover 5 years ago
Hi everyone,<p>I have been involved in a project that uses confluence to keep a software documentation. As the project develops in each version, keeping and viewing the documentation has become a hassle to a point that we append the date to the title to know which documentation is the latest one. So that got me thinking that maybe we can use Git to solve the versioning issue.<p>Eventhough Github and other version control website can already render markdown pages, but I need something that 1. Can render UML diagram 2. Can handle version link.<p>After a few weeks of hacking this is the result. A website that can convert a Github repo into a software documentation website. It still in it&#x27;s early stages but you can try out the demo :D