# star7th/showdoc

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具

Repository: https://github.com/star7th/showdoc
Canonical: https://ross.abutalabs.com/products/showdoc
Homepage: https://www.showdoc.com.cn
Language: PHP
License: NOASSERTION
License Family: other
Topics: showdoc, api, document, documentation-tool
Last push: 2026-08-24T05:58:44+00:00

## Health v2 (maintenance only)
Score: 98/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 95, longevity 100
- inputs: {"age_days": 3932, "days_push": 9, "days_rel": 37, "gap_med": 21, "n_releases_24m": 20}
- flags: no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 12850, forks 2219 (observed 2026-08-28T04:10:59.936599+00:00)

## What it is
ShowDoc is a self-hostable online documentation tool for IT teams, focused on API docs, data dictionaries, and technical manuals with a Markdown editor. It supports team permission management, document sharing/export, and auto-generating docs from code comments.

## Use cases
- write and share API documentation for a dev team
- create a data dictionary describing database schemas
- host internal technical manuals and tool instructions
- collaboratively edit team docs with permission control
- generate API docs from code comments
- export documentation as offline Word files

## When to choose
- your team needs a simple self-hosted wiki/API doc tool
- you want quick Markdown-based API and data dictionary docs
- you need public/private projects with member permissions

## When to avoid
- you need deep OpenAPI/Swagger spec tooling or code-first doc generation pipelines
- you want a general-purpose enterprise knowledge base with rich integrations
- you require a permissively licensed dependency (license is non-standard)

## Facets
- artifact type: application
- maturity: stable
- function: documentation, api-documentation, http-server, auth, markdown
- domain: documentation, web-development, developer-tools, apis, self-hosted
- platform: self-hosted, php
- tags: api-docs, data-dictionary, team-collaboration, markdown-editor, runapi, document-sharing, web-server, linux, docker

## Member repositories
- star7th/showdoc (main) score 98

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:59.936599+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:13:44.354137+00:00, confidence not recorded.
  - readme: https://github.com/star7th/showdoc (fetched 2026-08-28T04:10:59.936599+00:00, sha 22ac3485d873)
  - homepage: https://www.showdoc.com.cn (fetched 2026-08-29T08:09:49.882248+00:00, sha 23dd6aaa5f6d)
- Data as of 2026-08-30T08:39:29.467469+00:00.