What is this?
ShowDoc is a self-hosted tool for IT teams to write and share online documentation, especially API docs, data dictionaries, and technical specs.
ShowDoc is a self-hosted tool for IT teams to write and share online documentation, especially API docs, data dictionaries, and technical specs.Is this a document editor or more of a wiki platform?It's a web-based documentation platform with a Markdown editor, project-based organization, permissions, and version history — more like a lightweight Confluence focused on API docs.
It's a web-based documentation platform with a Markdown editor, project-based organization, permissions, and version history — more like a lightweight Confluence focused on API docs.How do I deploy ShowDoc on my own server?You self-host it, following the AutoInstall.md guide; Docker and docker-compose setups are also provided in the repo.
You self-host it, following the AutoInstall.md guide; Docker and docker-compose setups are also provided in the repo.What stack does it run on?ShowDoc is built in PHP and typically runs behind Nginx or Apache with SQLite as its default database.
ShowDoc is built in PHP and typically runs behind Nginx or Apache with SQLite as its default database.Any security pitfalls when self-hosting?Yes — if you self-host with Nginx or Apache, you must block access to the Sqlite/ directory or your instance is vulnerable to remote code execution.
Yes — if you self-host with Nginx or Apache, you must block access to the Sqlite/ directory or your instance is vulnerable to remote code execution.Can I keep documents private?Yes, projects can be set to private so only logged-in users with the project password can view them, versus public projects viewable by anyone.
Yes, projects can be set to private so only logged-in users with the project password can view them, versus public projects viewable by anyone.Can I export my docs for offline use?Yes, a project can be exported as an offline Word document, in addition to being read responsively on web and mobile.
Yes, a project can be exported as an offline Word document, in addition to being read responsively on web and mobile.Does it help me write API docs faster?Yes, the editor has one-click template insertion for API interface and data dictionary templates, so you just fill in the data.
Yes, the editor has one-click template insertion for API interface and data dictionary templates, so you just fill in the data.Can multiple people edit the same project?Yes, you can add project members who can edit documents, though only the owner can transfer or delete the project, and ownership itself can be transferred.
Yes, you can add project members who can edit documents, though only the owner can transfer or delete the project, and ownership itself can be transferred.Can I recover an old version of a doc if someone messes it up?Yes, ShowDoc keeps version history for every page so you can restore a previous version.
Yes, ShowDoc keeps version history for every page so you can restore a previous version.Which topics is it in?documentation-tool, apache, document, wiki, knowledge-management, note-taking, collaboration, php, knowledge-base, sqlite, rest-api, markdown
documentation-tool, apache, document, wiki, knowledge-management, note-taking, collaboration, php, knowledge-base, sqlite, rest-api, markdown