Socket
Socket
Sign inDemoInstall

codex.docs

Package Overview
Dependencies
472
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    codex.docs

[CodeX Docs](https://docs.codex.so/) is a free docs application. It's based on Editor.js ecosystem which gives all modern opportunities for working with content.


Version published
Weekly downloads
121
increased by12000%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

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
  • 💎 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

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.

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 👋TwitterInstagram
codex.socodex.so/join@codex_team@codex_team

FAQs

Last updated on 03 May 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc