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
34514761f5
* Updated highlight.js * Update .codexdocsrc.sample remove undefined page for a fresh new install * backend rewritten in TS * test -> TS, .added dockerignore, bug fixed * Removed compiled js files, eslint codex/ts added * fixed jsdocs warning, leaving editor confirmation * use path.resolve for DB paths * db drives updated + fixed User model * redundant cleared + style fixed * explicit type fixing * fixing testing code * added body block type * compiled JS files -> dist, fixed compiling errors * fixed compiling error, re-organized ts source code * updated Dockerfile * fixed link to parent page * up nodejs version * fix package name * fix deps Co-authored-by: nvc8996 <nvc.8996@gmail.com> Co-authored-by: Taly <vitalik7tv@yandex.ru> |
||
|---|---|---|
| .github/workflows | ||
| config | ||
| docker | ||
| public | ||
| src | ||
| .codexdocsrc.sample | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .nvmrc | ||
| docker-compose.yml | ||
| nodemon.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| webpack.config.js | ||
| yarn.lock | ||
CodeX Docs
Engine for documentation website using Editor.js
Development
Set up the environment
Install node version manager and required version of node js
$ chmod u+x ./bin/nvm.sh && ./bin/nvm.sh
$ nvm install
For windows use nvm for windows
Install Yarn package manager
$ brew install yarn --without-node
Use
--without-nodeflag because nvm version of Node is used
Or download it directly from the website
Install npm packages
$ yarn install --frozen-lockfile
Available scripts
Compile to Javascript
$ yarn compile
Start the server
$ yarn start
Run ESLint with --fix option
$ yarn lint
Run tests
$ yarn test
Authentication
To manage pages you need to authorize (available on /auth).
To generate password use yarn generatePassword [password] command.
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 👋 | ||
|---|---|---|---|
| codex.so | codex.so/join | @codex_team | @codex_team |