mirror of https://github.com/codex-team/codex.docs.git synced 2025-07-18 20:59:42 +02:00

Application de documentation gratuite, basé sur l'écosystème Editor.js offrant toutes les opportunités modernes pour travailler avec du contenu. https://codex.so

docs editorjs notes

Find a file

Tanya 5bbfd32621 Fix sidebar being impossible to hide on tablet screen (#266 )		2022-09-15 20:12:57 +03:00
.github	update actions versions (#217 )	2022-07-22 21:58:14 +08:00
config	Added ability to use custom favicon (#202 )	2022-07-10 15:21:32 +03:00
docker	First run improvements (improved DX and docs) (#169 )	2022-04-12 11:29:25 +04:00
public	Docker image optimization (#150 )	2022-03-06 13:37:06 +04:00
src	Fix sidebar being impossible to hide on tablet screen (#266 )	2022-09-15 20:12:57 +03:00
.codexdocsrc.sample	Added default index page, default startPage, removed iframe (#250 )	2022-09-12 20:11:44 +03:00
.dockerignore	Docker image optimization (#150 )	2022-03-06 13:37:06 +04:00
.editorconfig	Page model (#1 )	2018-08-17 13:58:44 +03:00
.env.sample	Feat/hawk integration (#210 )	2022-07-26 09:56:20 +05:30
.eslintignore	Frontent build system is ready (#3 )	2018-09-07 19:24:09 +03:00
.gitignore	Docker image optimization (#150 )	2022-03-06 13:37:06 +04:00
.nvmrc	Typescript rewrite (#147 )	2022-03-05 22:57:23 +04:00
.postcssrc	Upgrade packages (#149 )	2022-03-06 11:38:59 +04:00
docker-compose.yml	Password from env variable (#170 )	2022-04-24 16:54:36 +05:30
LICENSE	Create LICENSE (#159 )	2022-03-25 16:33:41 +04:00
nodemon.json	Beautify terminal output (#261 )	2022-09-14 13:27:31 +03:00
package.json	Added yarn start command to start on prod (#262 )	2022-09-14 15:50:36 +03:00
README.md	Changed cloning docs from yarn to git clone in README (#264 )	2022-09-14 17:43:46 +03:00
tsconfig.json	jsops: migrate to ESM from CJM (#228 )	2022-08-24 17:05:40 +03:00
webpack.config.js	Beautify terminal output (#261 )	2022-09-14 13:27:31 +03:00
yarn.lock	chore(hawk): fix hawk using the latest version (#255 )	2022-09-12 19:00:48 +03:00

README.md

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.

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

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

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