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

Nikita Melnikov ccbd79d6fe Env vars config override and some fixes (#277 ) * update config-loader and remove unnecessary packages * implement default config && move password to auth section * add 'v' to the start of image name * fix dockerfile * test * test pipeline * test again * fixes * remove test step * remove console log * fix default config		2022-11-03 12:38:13 +02:00
.github	Env vars config override and some fixes (#277 )	2022-11-03 12:38:13 +02:00
bin/db-converter	🤩MongoDB support 🤩 (#272 )	2022-10-03 20:23:59 +08:00
docker	Env vars config override and some fixes (#277 )	2022-11-03 12:38:13 +02:00
public	Docker image optimization (#150 )	2022-03-06 13:37:06 +04:00
src	Env vars config override and some fixes (#277 )	2022-11-03 12:38:13 +02:00
.dockerignore	🤩MongoDB support 🤩 (#272 )	2022-10-03 20:23:59 +08: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	[Feature] Static pages rendering 🤩 (#274 )	2022-10-17 08:25:38 +08:00
.npmignore	[Feature] Static pages rendering 🤩 (#274 )	2022-10-17 08:25:38 +08: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
DEVELOPMENT.md	[Feature] Static pages rendering 🤩 (#274 )	2022-10-17 08:25:38 +08:00
docker-compose.yml	[Feature] Static pages rendering 🤩 (#274 )	2022-10-17 08:25:38 +08:00
docs-config.yaml	[Feature] Static pages rendering 🤩 (#274 )	2022-10-17 08:25:38 +08:00
LICENSE	Create LICENSE (#159 )	2022-03-25 16:33:41 +04:00
nodemon.json	🤩MongoDB support 🤩 (#272 )	2022-10-03 20:23:59 +08:00
package.json	Env vars config override and some fixes (#277 )	2022-11-03 12:38:13 +02:00
README.md	🤩MongoDB support 🤩 (#272 )	2022-10-03 20:23:59 +08:00
tsconfig.json	[Feature] Static pages rendering 🤩 (#274 )	2022-10-17 08:25:38 +08:00
webpack.config.js	Beautify terminal output (#261 )	2022-09-14 13:27:31 +03:00
yarn.lock	Env vars config override and some fixes (#277 )	2022-11-03 12:38:13 +02: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

Development

See documentation for developers in 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