Docker/codex.docs
Docker/codex.docs
1
0
Fork 0
mirror of https://github.com/codex-team/codex.docs.git synced 2025-08-08 06:55:26 +02:00
Code Issues Releases Activity
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
157 commits 11 branches 24 tags 9.6 MiB
Find a file
Nikita Melnikov 48bf9ef9aa improve docs
2022-10-02 17:43:49 +08:00
.github update actions versions (#217) 2022-07-22 21:58:14 +08:00
bin/db-converter add readme and gitignore 2022-10-02 15:18:29 +08:00
docker update docker configs 2022-09-28 21:01:02 +08:00
public Docker image optimization (#150) 2022-03-06 13:37:06 +04:00
src improve docs 2022-10-02 17:43:49 +08:00
.dockerignore add src/test to docker ignore 2022-10-02 17:31:29 +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 update development docs 2022-10-02 17:23:45 +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
app-config.yaml update development docs and default config 2022-10-02 17:26:27 +08:00
DEVELOPMENT.md add docs about converter 2022-10-02 17:29:48 +08:00
docker-compose.yml move database code from utils 2022-10-02 17:37:14 +08:00
LICENSE Create LICENSE (#159) 2022-03-25 16:33:41 +04:00
nodemon.json fix bugs 2022-10-01 23:04:03 +08:00
package.json update development docs 2022-10-02 17:23:45 +08:00
README.md update development docs 2022-10-02 17:23:45 +08: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 update eslint packages 2022-09-29 08:47:46 +08: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.

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. 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.

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