CodeX Docs

CodeX Docs is a free, self-hosted documentation platform for creating and sharing internal, public, or personal knowledge bases.

  • Other
  • Productivity
  • Tools & Utilities
  • Web & Publishing
CodeX Docs is a free, self-hosted documentation platform for creating and sharing internal, public, or personal knowledge bases. Built on the Editor.js block editor, it provides a clean writing experience, flexible page nesting, human-readable SEO-friendly URLs, and responsive views on desktop and mobile.

Platform availability

Available on 2 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

15/100 Low

Maintained
0GitHub repository no longer exists
Popular
No data
Easy to install
452 install platforms, install notes, Docker image
Light to run
No data

Based on 2 of 4 factors.

Availability: platform listings confirmed today, links checked 3 days ago

No GitHub repository data collected yet.

Checked 54 days ago - source: GitHub (BigBearTechWorld/codex-docs)

Resources & Compatibility

Requirements not published yet.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Install the required SDK package Use npm, yarn, or pnpm (tools that download reusable code packages) to install @codex-data/sdk before you start. Without it, the app won’t have the pieces needed to connect to Codex. source
  • Configuration before install Create a docs-config.local.yaml file before installing the container; leaving it empty applies the default configuration. A sample configuration file is provided in the repository. source

Fetched 47 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Do I need to create a configuration file before installing the CodeX Docs container?

Yes. Create docs-config.local.yaml before installing the container; if it is left empty, the default configuration is applied, and a sample file is provided.

Is there a fix for the nested pages or nested documents limit?

One user reports that they found a fix for the nested documents issue and shared it for others.

Can CodeX Docs be self-hosted using Docker?

Yes. The self-hosting page presents a Docker install guide for CodeX.docs.

What third-party integrations have been noted in CodeX Docs?

It appears to include Yandex and Hawk integrations.

Answers sourced from github.com, selfhost.directory, www.reddit.com, www.reddit.com

Community

Collected 53 days ago - public community threads