yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-08-31 21:03:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): fast reload command for markdown edits (#6539)

Browse Source
This commit is contained in:
Harshal Sheth 2022-11-29 00:52:16 -05:00 committed by GitHub
parent 7f93ee5f13
commit d4bf6ce3fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs-website/README.md
View File

@ -10,17 +10,15 @@ yarn install
## Local Development
```console
```sh
# This command starts a local development server and open up a browser window.
../gradlew yarnStart
# You may also have success running the underlying commands manually.
yarn run lint
yarn run generate
yarn run start
# Every time a markdown file is changed, update the site:
# If a more complex docs site change is made, you'll need to restart the server.
../gradlew fastReload
```
This command starts a local development server and open up a browser window.
## Build
```console

3
docs-website/build.gradle
View File

@ -77,6 +77,9 @@ task yarnGenerate(type: YarnTask, dependsOn: [yarnInstall, generateGraphQLSchema
task yarnStart(type: YarnTask, dependsOn: [yarnInstall, yarnGenerate]) {
args = ['run', 'start']
}
task fastReload(type: YarnTask) {
args = ['run', 'generate-rsync']
}
task yarnLint(type: YarnTask, dependsOn: [yarnInstall]) {
inputs.files(projectMdFiles)

2
docs-website/generateDocsDir.ts
View File

@ -15,7 +15,7 @@ const GITHUB_EDIT_URL =
const GITHUB_BROWSE_URL =
"https://github.com/datahub-project/datahub/blob/master";
const OUTPUT_DIRECTORY = "genDocs";
const OUTPUT_DIRECTORY = "docs";
const SIDEBARS_DEF_PATH = "./sidebars.js";
const sidebars = require(SIDEBARS_DEF_PATH);

6
docs-website/package.json
View File

@ -10,8 +10,10 @@
"deploy": "docusaurus deploy",
"serve": "docusaurus serve",
"clear": "docusaurus clear && rm -rf genDocs/*",
"generate-graphql-internal": "docusaurus docs:generate:graphql",
"generate": "rm -rf docs genDocs && mkdir docs genDocs && yarn generate-graphql-internal && ts-node -O '{ \"lib\": [\"es2020\"], \"target\": \"es6\" }' generateDocsDir.ts && mv -v docs/* genDocs/ && rmdir docs",
"_generate-graphql": "mkdir -p genDocs && docusaurus docs:generate:graphql",
"_generate-docs": "rm -rf docs && mkdir docs && yarn _generate-graphql && ts-node -O '{ \"lib\": [\"es2020\"], \"target\": \"es6\" }' generateDocsDir.ts",
"generate": "rm -rf genDocs && mkdir genDocs && yarn _generate-docs && mv docs/* genDocs/ && rmdir docs",
"generate-rsync": "mkdir -p genDocs && yarn _generate-docs && rsync -v --checksum -r -h -i --delete docs/ genDocs && rm -rf docs",
"lint": "prettier -w generateDocsDir.ts sidebars.js src/pages/index.js",
"lint-check": "prettier -l generateDocsDir.ts sidebars.js src/pages/index.js",
"lint-fix": "prettier --write generateDocsDir.ts sidebars.js src/pages/index.js"