Popularity
4.3
Growing
Activity
0.0
-
580
25
59

Description

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.

Programming language: TypeScript
License: Apache License 2.0
Tags: Markdown     Documentation     Docs     Static Site Generators     Snippets    

CodeX Docs alternatives and similar software solutions

Based on the "Static Site Generators" category.
Alternatively, view codex.docs alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of CodeX Docs or a related project?

Add another 'Static Site Generators' Software solution

README

CodeX Docs

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.

page-overview-bright

It's super easy to install and use.

Features

  • 🀩 Editor.js ecosystem powered
  • πŸ“‚ Docs nesting β€” create any structure you need
  • πŸ“± 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

Demo

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

Guides

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

Getting Started

1. Clone the repo.

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

2. Fill the config

Read about available configuration options.

3. Run the application

Using Yarn

yarn && yarn start

Using Docker

docker-compose build
docker-compose up

Using Kubernetes

We have the ready-to-use Helm chart to deploy project in Kubernetes

Development

See documentation for developers in [DEVELOPMENT.md](./DEVELOPMENT.md).

About CodeX

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

🌐 Join πŸ‘‹ Twitter Instagram
codex.so codex.so/join @codex_team @codex_team