Skip to content

Commit ed2ae41

Browse files
authored
refactor(docs): move all docs sources to a dedicated docs package (maxGraph#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
1 parent 3d1d68a commit ed2ae41

File tree

540 files changed

+29
-48651
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

540 files changed

+29
-48651
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Generate documentation
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- development
7+
paths:
8+
- '.github/workflows/generate-documentation.yml'
9+
- 'packages/core/*'
10+
- 'packages/docs/*'
11+
- 'package.json'
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-22.04
16+
steps:
17+
- uses: actions/checkout@v3
18+
- name: Setup node
19+
uses: actions/setup-node@v3
20+
with:
21+
node-version-file: '.nvmrc'
22+
- name: Install dependencies
23+
run: npm install
24+
- name: Build @maxgraph/core API docs
25+
working-directory: packages/core
26+
run: npm run docs:api

docs/api/.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/assets/highlight.css

Lines changed: 0 additions & 155 deletions
This file was deleted.

0 commit comments

Comments
 (0)