Repolode
Submit
star7th

star7th/showdoc

Self-hosted online documentation tool for IT teams, focused on API docs, data dictionaries and Markdown-based team wikis.

Open-source alternative to:ConfluenceNotion

View on GitHubWebsite
Stars
12,872
Forks
2,212
Open issues
235
Last commit
4 days ago

What is it?

ShowDoc is a web-based document sharing tool built for software teams. It targets a common problem: code written by one person is hard for others to pick up when no current documentation exists, and documents scattered across Word files and chat messages go stale quickly.

The main uses are API documentation, where you can create interface pages quickly from templates, data dictionaries that describe database fields, and general explanation or technical specification documents. Pages are written in Markdown, and every page keeps a version history so earlier versions can be restored. Projects can be public or private, transferred between owners, and shared with members, and they can be exported as offline Word documents.

ShowDoc can be deployed on your own server. The project's documentation includes an installation guide and a security hardening guide for Nginx and Apache users.

Key features

  • 01Built-in API interface and data dictionary templates for quick page creation.
  • 02Markdown editor with per-page version history.
  • 03Public and private projects with member management and ownership transfer.
  • 04Responsive layout for reading on desktop and mobile.
  • 05Export projects as offline Word documents.
  • 06Self-hostable on your own server.

Use cases

  • Documenting backend APIs so frontend and mobile developers can consume them.
  • Maintaining a database data dictionary that explains every field.
  • Writing internal tool instructions or technical specifications for a team.
  • Taking over a legacy project that lacks written documentation.

Quick start

  1. 1

    Deploy on your own server by following the AutoInstall guide

Things to know

  • Self-hosting is required, and Nginx or Apache users must deny access to the Sqlite/ directory for security.
  • The license is listed as NOASSERTION in the metadata, and the README adds copyright terms beyond Apache 2.0 that require keeping copyright notices and links in the UI.

In collections

Self-hosted appsStatic site generators & documentation tools

Topics

#api-documentation#documentation#markdown#self-hosted#wiki#team-collaboration#api#document#documentation-tool#showdoc

FAQ

What is showdoc?
Self-hosted online documentation tool for IT teams, focused on API docs, data dictionaries and Markdown-based team wikis. ShowDoc is a web-based document sharing tool built for software teams. It targets a common problem: code written by one person is hard for others to pick up when no current documentation exists, and documents scattered across Word files and chat messages go stale quickly.
Is showdoc free to use? What license does it have?
showdoc is open source under the Other license. Check the license terms before using it in commercial products.
Is showdoc still maintained?
Actively maintained. The last commit to showdoc was on Nov 3, 2026.
What can I use showdoc for?
Documenting backend APIs so frontend and mobile developers can consume them. Maintaining a database data dictionary that explains every field. Writing internal tool instructions or technical specifications for a team. Taking over a legacy project that lacks written documentation.
How do I install showdoc?
Deploy on your own server by following the AutoInstall guide
Where can I get showdoc?
The source code and installation instructions are on GitHub: https://github.com/star7th/showdoc

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects