zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/.github/workflows/generate-website.yml

39 lines
975 B
YAML
Raw Normal View History

docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
name: Generate website
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
on:
pull_request:
branches:
- development
paths:
docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
- '.github/workflows/generate-website.yml'
chore: build with Node 18 (#263)
2023-11-16 13:39:08 +00:00
- '.nvmrc'
docs: improve the migration guide from mxGraph (#271) Provide various improvements - fix `InternalEvent` - improve `Client` - improve explanations about plugins - removed `mxUtils` methods - removed `isVisible` methods Also use more admonitions.
2023-12-03 23:57:50 +00:00
- 'packages/core/**/*'
- 'packages/website/**/*'
- '!packages/website/README.md'
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
- 'package.json'
jobs:
build:
runs-on: ubuntu-22.04
steps:
chore(deps-gha): bump actions/checkout from 3 to 4 (#240)
2023-09-11 06:58:05 +00:00
- uses: actions/checkout@v4
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
- name: Setup node
chore(deps-gha): bump actions/setup-node from 3 to 4 (#258)
2023-10-30 06:19:15 +00:00
uses: actions/setup-node@v4
refactor(docs): move all docs sources to a dedicated docs package (#168) Keep the former mxGraph documentation to allow a later documentation migration. Remove both the former mxGraph and the new maxGraph API docs as they can be generated. Remove the former mxGraph examples home page as it has been replaced by Storybook. Update the configuration to generate the maxGraph API docs - remove jsdoc resources as it is not used anymore - configure the core package to generate the API docs in the docs package - add a GitHub workflow to ensure we can generate the API docs without errors
2023-01-09 15:03:52 +00:00
with:
node-version-file: '.nvmrc'
- name: Install dependencies
run: npm install
- name: Build @maxgraph/core API docs
working-directory: packages/core
run: npm run docs:api
docs: build the user documentation with Docusaurus (#264) Initiate the website with Docusaurus v3. Setup the site and includes the content that was already available in the `docs` package. The currently implementation mainly uses the default theme available when using the Docusaurus scaffolding. It was initiated with: `npx create-docusaurus@3.0.0 my-website classic`
2023-11-27 17:53:52 +00:00
- name: Build website
working-directory: packages/website
run: npm run build
- name: Upload website artifact
uses: actions/upload-artifact@v3
with:
name: website-${{github.sha}}
path: |
packages/core/build/api/
packages/website/build/