star7th/showdoc

★ 12,821PHPAudience · developerComplexity · 2/5LicenseSetup · moderate

Mindmap

mindmap
  root((ShowDoc))
    What it does
      API documentation
      Database schema docs
      Team guidelines
    Features
      Markdown editor
      Version history
      Templates
    Access control
      Public projects
      Private with password
      Team members
    Deployment
      Self-hosted PHP
      Hosted service
      Automated installer

mindmap root((ShowDoc)) What it does API documentation Database schema docs Team guidelines Features Markdown editor Version history Templates Access control Public projects Private with password Team members Deployment Self-hosted PHP Hosted service Automated installer

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Host a shared API reference so your frontend and backend teams always see the same endpoint docs.

USE CASE 2

Build a team knowledge base with version-controlled pages for technical standards and onboarding guides.

USE CASE 3

Document a database schema so new team members can quickly understand what each table and field means.

USE CASE 4

Self-host a private documentation site on your own server using the automated installer.

Tech stack

PHPMarkdown

Getting it running

Difficulty · moderate Time to first run · 30min

Requires a PHP server to self-host, alternatively use the hosted version at showdoc.com.cn with no setup.

Apache 2.0, use freely for any purpose including commercial, modify and distribute as long as you keep the copyright and license notice.

In plain English

ShowDoc is an online documentation tool built for software development teams. It solves a common frustration: when someone joins a project or takes over from a colleague, there is often no organized place to find API references, database descriptions, or technical guides. Documentation ends up scattered across email threads, instant messages, and Word files on individual computers. ShowDoc replaces that chaos with a shared, browser-accessible space where everyone on the team can read and contribute. The tool supports three main types of documents. API documents describe how a server's endpoints work, including what parameters each one accepts and what it returns. This is useful when a backend team needs to communicate with a frontend team or a mobile app team. Data dictionary documents describe a database structure, spelling out what each table and field means. Explanation documents are general-purpose pages for writing team guidelines, tool instructions, or technical standards. Editing is done in Markdown, a lightweight text format that converts to clean HTML. The editor includes templates for common document types, so you can insert an API template or a data dictionary template and fill in the blanks rather than starting from scratch. Each page keeps a history of previous versions, so you can roll back a change if needed. Projects can be set to public or private. Public projects are readable by anyone with the link. Private projects require a password. Project owners can add team members who can edit content, transfer ownership to someone else, or export the whole project as an offline document. ShowDoc can be hosted on your own server using an automated installer, or used through the hosted version at showdoc.com.cn. The code is written in PHP and released under the Apache 2.0 license, which allows free use and modification.

Copy-paste prompts

Prompt 1

I'm using ShowDoc to document my REST API. Write a ShowDoc API template entry for a POST /users endpoint that accepts name, email, and password fields and returns a user object with id and created_at.

Prompt 2

Help me write a ShowDoc data dictionary entry for a 'payments' table with columns: id, user_id, amount, currency, status, and created_at.

Prompt 3

I'm migrating from Word docs to ShowDoc. How should I organize my team's documentation into projects and pages for a mobile app with a separate backend API?

Prompt 4

Write a team guidelines page in Markdown for ShowDoc covering how to write API documentation, including required fields and formatting rules.

Open on GitHub → Explain another repo

← star7th on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.