@rasahq/docusaurus-tabula
v1.0.0-alpha.1
Published
`docusaurus-tabula` is a preset, theme, and configuration-generator for the [Docusaurus documentation framework](https://docusaurus.io/).
Downloads
8
Keywords
Readme
Docusaurus Tabula
docusaurus-tabula
is a preset, theme, and configuration-generator for the Docusaurus documentation framework.
Background
This package intended to align roughly with the "tabula" design style, which is otherwise used on rasa.com. It is intended as a replacement to the Docusaurus theme in use on the following sites:
Installation
npm i --save @rasahq/docusaurus-tabula
Usage
// docusaurus.config.js
const tabula = require('@rasahq/docusaurus-tabula');
module.exports = tabula.use({
customFields: {
title: 'Rasa Open Source Documentation',
tagline: 'An open source machine learning framework for automated text and voice-based conversations',
productLogo: '/img/logo-rasa-oss.png',
legacyVersions: [{
label: 'Legacy 1.x',
href: 'https://legacy-docs-v1.rasa.com',
target: '_blank',
rel: 'nofollow noopener noreferrer',
}],
redocPages: [
{
title: 'Rasa HTTP API',
specUrl: '/spec/rasa.yml',
slug: '/pages/http-api',
}
],
announcementBar: {
id: 'pre_release_notice', // Any value that will identify this message.
content: 'These docs are for version 3.x of Rasa Open Source. <a href="https://rasa.com/docs/rasa/2.x/">Docs for the 2.x series can be found here.</a>',
backgroundColor: '#6200F5', // Defaults to `#fff`.
textColor: '#fff', // Defaults to `#000`.
// isCloseable: false, // Defaults to `true`.
}
}
};
Development
To start a development server run the following at the root of this repository:
yarn && yarn workspace testing-rasa dev
To understand how we are building the configuration and which business and user needs it covers, please refer to the documentation comments in /packages/docusaurus-tabula/index.js
NOTE: changes to this package other than React component changes will often require restarting the development server.