mirror of
https://github.com/datahub-project/datahub.git
synced 2025-09-16 20:53:18 +00:00
0be0689093
* testing img.shield for status * update to hyperlink * changing link format * adding status options * updating prerequisities and quickstart * update to ingestion docs * updating template with collapse details * adding linebreak between pip install commands * Removed incomplete sentence * typo fix * pushing current changes * testing logos in markdown table * markdown table fix * markdown table fix * adding in additional logos * transposing markdown table * settling on final table format * adding commented-out source template to sidebar.js * moving reference sidebar and adding trailing comma * fixing docs build
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
yarn install
Local Development
yarn run lint
yarn run generate
yarn run start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Build
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Generating GraphQL API Docs
To regenerate GraphQL API docs, simplym rebuild the docs-website directory.
./gradlew docs-website:build