codex-team / codex.docs

Free Docs app powered by Editor.js ecosystem

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

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

codex.docs's Issues

Code blocks` syntax highlighting does not work

Looks like highlight.js is broken. Need to check what happened.

Add support for absolute path in Docs config

https://github.com/codex-team/codex.docs/blob/main/src/backend/utils/database/initDb.ts#L13

User may wants to specify absolute path to storage rather than relative to docs application. This way also preferable for Kubernetes deployments.

Show list of subpages if page has no content

If page was created to be a section (as folder) and it has no content may be it would be great if I will be able to see list of subpages.

Or every page can contain subpages list at the end. As codex.media platform: example.

Config files refactoring

At now we have two separate configuration files. I think that we can unite this two files in one common config file.

We need to discuss format of this file and its features (plugins, for example)

Add responsive layout

Add unit tests to pages removing

Landing: detect current NPM version

See example

Add og markup

Database is in an unexpected place

On my production server database directory is in the root of the system /.db/pages.db. While I am trying to find it in project's directory ./.db/pages.db.

Need to compose path to database file via path.resolve().

codex.docs/src/utils/database/pages.js

Line 4 in d618187

const db = new Datastore({filename: `./${config.database}/pages.db`, autoload: true});

Allow to show ads by Carbon

Don't allow to set child element as parent.

Opportunity page change parent page to children element

[Bug] Changing header type drops it's innerHTML

Add misprints package

Improve form for pages editing

At now we have bad UI for creating and positioning new pages

What to do

• Improve dropdown for parent article choosing
• Improve UI of other fields (order, alias etc)

Add Image Tool with uploader backend to the landing

Define list of forbidden aliases

Implement application versioning and changelog generation

For production usage we need to implement application versioning and changelogs for our users

Create Helm chart for docs deploying in separate repo

Don't allow to leave editor if data was not saved.

Show prompt «You really want to leave this page without saving?»

Fix sorting in dropdown with articles on article edit page

Steps to reproduce:

1. Go to docs.codex.so
2. Authenticate via https://docs.codex.so/auth
3. Click "+ Add page" button
4. Now you can see dropdown "New page at":

**But articles is this dropdown are sorted incorrectly** They must be sorted as articles in the left column:

Unhardcode lading stuff

Add table tool

Design third column with navigation inside page

Add check for user existence on POST /auth

Add template for Delimiter Block

Add prev/next buttons to the pages

Переделать CreateMenu

Нужно переделать рекурсивный метод, который получает порядок подстраниц.
Новый алгоритм:
получаем все страницы и порядок для подстраниц. Обходим по очереди страницы и дочерние страницы сортируем по порядку или просто по тому порядку в котором они есть

Add authentication

• Add /auth page with field for password
• Check password on backend from file (eg. .db/password.db or from .env file)
• If password is correct, set cookie with JWT
• On each page if there is JWT in cookies allow user to create or edit articles
• Do not show New and Edit button if user isn`t authenticated

Dispatcher removes all inline tags

codex-team/moduleDispatcher#7

When clicking on the Add page button, remember the current page

It is necessary to set the current page as a parent in the parent page selection field

Steps to reproduce: - run docs instance - auth via /auth - go to some existing page - click "Add new page" - You will see that new page will be created in the "Root", but it would be much more convenient if there was a page that the user was on before

Allow to add inline code to headers

ui: update layout

Update the layout of the application:

1. The new dimensions of the Header, Sidebar, Body, Right Column
2. The new element: Right Column
3. The Sidebar and the Header have been fixed.
4. The Sidebar and the Right Column have internal scroll
5. The Sidebar has the fixed width
6. The Right Column has a responsive width depending on the screen size. It should be placed at a maximum of 160px right from the content zone.

Mockup with main parts of layout: https://www.figma.com/file/P3X5qbxV5DZ0cM2arsmkrP/docs?node-id=158%3A211

Mockup with actual paddings, elements and so on: https://www.figma.com/file/P3X5qbxV5DZ0cM2arsmkrP/docs?node-id=63%3A47

History: добавить сохранение всех версий страниц при изменениях

При сохранении страницы нужно не перезаписывать прошлую информацию, а создавать новую сущность. Необходимо добавить поле dtModify и записывать туда таймстемп момента сохранения.

Получение самой свежей версии страницы решается поиском по id и сортировкой по dtModify.

Старые версии страницы должны быть доступны по ссылкам с GET параметром version.

/page/5flYp0h8HKWMeINY?version=1548255132476

Необходимо иметь возможность открыть для редактирования любую версию и сохранить её, сделав актуальной.

Discussion: frontend refactoring

Disadvantages of the current frontend implementation:

• JS code base is hard to maintain for big project (which docs can be in the future). It is better to refactor to TS
• Twig templates: deprecated and hard to support
• hard to serve twig templates and static assets (svg images, for example)

we should think about how we can fix these problems and maybe move to a more modern stack

Redesign of the left column

Про .codexdocsrc

Надо добавить информацию о .codexdocsrc в readme.md

Choose license type

Right now we do not have a license selected for the product and we need to select it

Raw-HTML is appended to page title

Research about how to fix problem with iframe on the main page

Most of the projects doesn't need landing page via iframe on the main page and we should this about how to get around this

Show parent page title instead of _id at the navigation line

ui: update copy-link behaviour

Currently, there are some problems with copy-link behavior:

Problems:

1. Hovering the Heading blocks shows the "copy" icon, but it is actually not a button (no click handler).
2. When you try to hover over the "copy" icon, it will disappear.
3. Nothing happened by clicking on the "copy" icon
4. Actually, there is no copying, just replacing the URL with hash.
5. No "success" signal

The new version should

1. Work like a button
2. Appear by hovering a header block, disappear with delay
3. Actually put the URL to the Buffer
4. Play the success-animation

5. The Header itself shouldn't have a click handler.

🌅 Mockup: https://www.figma.com/file/P3X5qbxV5DZ0cM2arsmkrP/docs?node-id=155%3A194

Add reactions

Add beautiful urls

Current page URLs looks like

https://editorjs.io/page/rPT11QRMYLW8gXSi
https://editorjs.io/page/wxiTGkGxG9pxHj2w

We need to get something like this:

https://editorjs.io/base-concepts
https://editorjs.io/usage

So we need to create alias system:

1. Add uri field to the Page
2. Add aliases table that will be store binary hash of alias and entity type and id
3. On page creation, fill uri by transliterated title
4. Add ability to change uri manually
5. Add alias route below our core-routes list. Route will look at aliases page and find entity.
6. Support old (changed) aliases by deprecated property at aliases table. They should redirect to new alias until new entity wants to get this alias.

Allow using static page as the main page

If user provides static "index" page show it on main page

Highlight current page at the aside-menu

Add test for authentication logic

Use first page as default

First page of root folder should be shown by default

Add warning tool

Pass docs password from environment variable

For security and convenience reasons it is better to pass docs password for /auth route via environment variable, rather than storing it in database and generating via script.
This feature also will allow us to pass password via Kubernetes secret.

Problem with grey lines on chrome