realtimedatalake / rtdl-docs

rtdl documentation website built with Nextra

rtdl-docs

rtdl documentation website. Built with Nextra.

rtdl - The Real-Time Data Lake ⚡️

This is a sub-project of rtdl – the real-time data lake. Please go to rtdl's repo and give it a star.

How to Use 🌱

Find details on how to use Nextra here.

• cd into the docs folder.
• Run npm install.
• Install Next.js, Nextra and React, run npm install next nextra react react-dom.
• Install the docs theme, run npm install nextra-theme-docs.
• To run rtdl's documentation website locally in dev mode, run npm run dev. You can view the site at http://localhost:3000/docs/.
• To build rtdl's documenatation wesite locally to the /out folder, run npm run build-prod.

License 🤝

MIT

Contributing 😎

Contributions are always welcome!
See our CONTRIBUTING for ways to get started. This project adheres to the rtdl code of conduct - a direct adaptation of the Contributor Covenant, version 2.1.

Appreciation 🙏

• Nextra