iFood Docusaurus Theme

iFood's official Docusaurus theme

About

This project was created to provide a consistent experience trought iFood project's documentations using Docusaurus. It relies in Swizzling feature of Docusaurus, which allows deeper site customizations. Swizzling permits to swap a theme component with our implementation. Thanks to this feature and all customization given to us by the tool, we could easily create this theme.

Note: It's currently unstable due the not full support to themes from Docusaurus. If there's any problem with the usage, please open an issue.

Preview

Getting started

Required:

• Docusaurus >= 2.0.0
• Node >= 16.14.0

1. Install docusaurus

Due the unstable version of Docusaurus, we currently recomend use the version 2.0.0-beta.9. We don't guarantee that the theme will work properly in other versions.

The Docusaurus theme must be the classic in order to the customization work properly.

npx [email protected] [project-name] classic

2. Install the package

npm i @ifood/docusaurus-theme

3. Push the theme to the themes array in docusaurus.config.js

...
projectName: 'docusaurus', // Usually your repo name.
themes: [
    '@ifood/docusaurus-theme'
],
presets: [
...

Code of Conduct

iFood has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to the project.

Examples

Example folder here.