# CodeX Docs

> A clean docs site with a block editor, free to self-host.

- Page: https://cgt.octabyte.io/templates/codex-docs/
- Category: Docs & wikis
- Replaces: GitBook and Notion
- Ease of use: Easy. Sign in with the editing password Cloudgate creates and add your first page; the site's name and top menu links are changed in a settings file.
- App price: Free. To run it you need Cloudgate (hosted, or free to install yourself) and a server, which hosted Cloudgate can provide.
- License: Apache-2.0
- Good for: Small teams publishing a tidy docs site or handbook, edited by a few people who share one password
- Official website: https://docs.codex.so
- Documentation: https://docs.codex.so/getting-started
- Source code: https://github.com/codex-team/codex.docs
- Last updated: 2026-11-20

## What is CodeX Docs?

CodeX Docs is a self-hosted docs app: write product docs, team guides and handbooks in a block editor and publish them as a clean, nested docs site.

CodeX Docs is a free, self-hosted docs app and an open-source alternative to GitBook and Notion for publishing product docs, team guides and handbooks. You write each page in a block editor, nest pages into sections, and readers get a clean docs site with readable web addresses.

Pages are built from blocks such as headings, checklists, tables, code, images and warning boxes, and every page shows its own contents list. A bakery, for example, could publish an opening checklist, a bake schedule and food safety rules for new staff, and keep its recipes and supplier notes in sections of the same site.

Anyone with the address can read the docs, on a computer or a phone, and editing is unlocked with one shared password. CodeX Docs is deliberately small: there are no user accounts, private pages, page history, comments or full-text search, and the site's name and menu links live in a settings file. Readers can report typos straight to your Slack or Telegram chat.

Cloudgate installs CodeX Docs on a server Cloudgate provides or one you connect, and gives it a secure web address. Sign in with the password Cloudgate creates and add your first page. Your docs stay on your server.

## What you can do with CodeX Docs

- **Write in blocks**: Build each page from blocks such as headings, lists, checklists, tables, code, images, embeds and warning boxes.
- **Nest pages into sections**: Choose a parent for each page and the sidebar shows your docs as sections with sub-pages, in the order you set.
- **Give pages readable addresses**: Each page gets a short web address such as /opening-the-shop that is easy to share and bookmark.
- **Help readers find their way**: A sidebar search finds pages by title, each page lists its own headings, and sections can be collapsed.
- **Publish to anyone, edit with a password**: Anyone with the address can read your docs, while one shared password unlocks adding and editing pages.
- **Hear about typos from readers**: Readers can select a mistake and press Shift+Enter to report it to your Slack or Telegram chat.
- **Read comfortably on phones**: The docs site adapts to small screens, with the contents tucked into a menu.

## Replaces GitBook and Notion

CodeX Docs does the same job as GitBook and Notion. Here is what changes when you switch.

### What you gain

- No fee per editor, per reader or per docs site
- A Notion-style block editor with a clean, GitBook-like reading layout
- Your pages stay on your own server, with no separate database to look after
- A small app that is quick to set up and simple to learn

### What is different

- One shared editing password, with no user accounts, roles or private pages
- No page history, comments or live co-editing
- Search finds pages by title only, not by the words inside them
- No importer from GitBook, Notion or Markdown, so pages are rebuilt by hand

## What happens when you click Deploy?

Deploy link: https://cloudgate.octabyte.app/get-started?template=codex-docs

1. **Click Deploy and create your account.** Deploy takes you to Cloudgate. Create an account, or log in if you have one. CodeX Docs itself is free.
2. **Choose a server.** No server? Get one from Cloudgate: pick a size and a country, and Cloudgate gets it ready. Already have one? Connect it instead.
3. **Cloudgate sets up CodeX Docs.** It prepares the server, makes the passwords the app needs and starts it. There is nothing to install and nothing to write down.
4. **Open your app and sign in.** Your app gets a free web address to start, without https. Add your own domain, like app.yourshop.com, and Cloudgate secures it with https for you.

## Questions

### Is CodeX Docs free?

Yes, CodeX Docs is free and open source under the Apache 2.0 licence, with no paid edition. You pay only for the server it runs on, with no fee per editor or reader.

### Is CodeX Docs a good alternative to GitBook?

Yes, for a small public docs site or handbook. CodeX Docs gives you nested pages, an on-page contents list and readable addresses like GitBook, but it has no Git sync, user accounts, page history or full-text search.

### How do I sign in to CodeX Docs the first time?

Open the /auth page of your CodeX Docs address and enter the editing password Cloudgate created, shown on the app's variables page. There are no user accounts; once signed in, an Add page button appears.

### Can several people edit CodeX Docs?

Yes, but everyone who edits CodeX Docs shares the same editing password, and each person who has it can change every page. There are no separate logins, roles or per-page permissions, so it suits a small team that trusts each other.

### Who can read my CodeX Docs site?

Anyone with the address can read every page, because CodeX Docs is made for published docs; only editing needs the password. It has no private pages, so keep confidential material in another tool.

### Can I import my docs from GitBook, Notion or Markdown files into CodeX Docs?

No, CodeX Docs has no importer. You create each page in its block editor and paste in your text, then upload images again.

### Do I need technical skills to run CodeX Docs?

No. Click Deploy, create your Cloudgate account and choose a server, and Cloudgate sets up CodeX Docs and gives it a web address. You use it in your browser like any other online tool.

### Do I need my own server for CodeX Docs?

No. When you deploy CodeX Docs, hosted Cloudgate can provide a server. If you already rent one, you can connect it instead.
