Skip to content

p3ol/oak

Repository files navigation



GitHub CI codecov

A modern, lightweight & modulable block-based builder for the modern web

Packages

Name Description
@oakjs/react A render for React documentation
@oakjs/theme A base theme for Oak documentation
@oakjs/addon-remirror WYSIWYG text field for the React renderer using Remirror documentation
@oakjs/addon-ckeditor5-react WYSIWYG text field for the React renderer using CKEditor 5 documentation
@oakjs/strapi-plugin A plugin to add a custom Oak field to Strapi documentation
@oakjs/core The core of the famous builder documentation

Documentation

The documentation of each package is available in the README.md file of the said package.

Development

Install dependencies:

yarn install

Run examples with Storybook:

yarn serve

Contributing

Please check the CONTRIBUTING.md doc for contribution guidelines.

License

This software is licensed under MIT.