React based DBT Docs site.
One of the awesome features of DBT is the documentation site it is able to generate for your project. And for a majority of use cases the existing docs site is likely more than adequate.
However I ran into a situation where I wanted to be able to share a single docs site across many seperate dbt projects. This presented some challenges, which prompted attempts at work-arounds and finagling to get the desired results which ultimatly did not pan out. Leading me to taking a closer look into the code-base behind the existing dbt-docs and seeing if there was some adjustments that could be made to suite my needs.
After some consideration there seemed to be two options:
- Modify the existing code-base to get what I was looking for. And if I couldn't get the changes merged maintain my own fork essentially.
- Create my own solution from scratch, using the existing dbt-docs as a reference/template.
And I decided on option 2
The 3 biggest differences with the existing dbt-docs are
- React instead of Angular.js
- The graph editor is custom as opposed to using the crytoscape library.
- TypeScript.
The project was originally created for internal use to fit a particular need, but I love open-source so this version is being made available for the broader public to use and contribute to.
would love to have this project be adopted by the great folks at dbt-labs as possibly a new version of the dbt-docs.
After cloning the repo run:
yarn install
then just run:
yarn start