Repository files navigation

CodeX Docs is a free docs application. It's based on Editor.js ecosystem which gives all modern opportunities for working with content.

You can use it for product documentation, for internal team docs, for personal notes or any other need.

It's super easy to install and use.

• 🤩Editor.js ecosystem powered
• 📂 Docs nesting — create any structure you need
• 💎 Static rendering
• 📱 Nice look on Desktop and Mobile
• 🔥 Beautiful page URLs. Human-readable and SEO-friendly.
• 🦅Hawk is hunting. Errors tracking integrated
• 💌Misprints reports to the Telegram / Slack
• 📈Yandex Metrica integrated
• 🚢 Deploy easily — no DB and other deps required
• 🤙 Simple configuration
• ⚙️ Tune UI as you need. Collapse sections, hide the Sidebar

Here is ourDemo Application where you can try CodeX Docs in action.

1. Getting Started
2. Configuration
3. Kubernetes deployment
4. Authentication
5. Writing
6. How to enable analytics
7. Contribution guide

git clone https://github.com/codex-team/codex.docs

Read about availableconfiguration options.

yarn&& yarn start

docker-compose builddocker-compose up

We have the ready-to-useHelm chart to deploy project in Kubernetes

See documentation for developers inDEVELOPMENT.md.

CodeX is a team of digital specialists around the world interested in building high-quality open source products on a global market. We areopen for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.