Skip to content

Commit 693af7c

Browse files
committed
feat: auto-build the doc
1 parent 3d3ded2 commit 693af7c

File tree

24 files changed

+489
-142
lines changed

24 files changed

+489
-142
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/user/generalUsage.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# General usage
2+
3+
## Navigate between applications
4+
5+
You can click on the \`Add application\` button to create a new instance of an application. The list of open instances appears in the sidebar on the left. Clicking on one of these instances will display it in the center of the dashboard
6+
7+
## Share applications
8+
9+
To share applications, click the \`Export\` button at the top right of the screen. Then, select the applications you want to share and copy them to the clipboard.
10+
11+
## Import applications
12+
13+
To import applications, click the \`Import\` button at the top right of the screen. Paste the copied applications into the input field and click \`Import\`. The imported applications will appear in the sidebar.
14+
If the states are outdated, you can copy the updated version of them by clicking the \`Copy all updated states\` button.
15+
16+
## Save you dashoard
17+
To save your dashboard, clicke the \`Export\`button at the top right of the screen. Then, select the applications you want to save and click on the \`Save in the browser\` button. The saved applications will be stored in your browser's local storage.
18+
When you want to load the saved applications, click the \`Import\` button at the top right of the screen and select the \`Load from the browser\` option. The saved applications will be loaded into the sidebar.

package-lock.json

Lines changed: 202 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
"devDependencies": {
1111
"@commitlint/cli": "^19.7.1",
1212
"@commitlint/config-conventional": "^19.7.1",
13-
"husky": "^9.0.11"
13+
"@types/node": "^24.1.0",
14+
"husky": "^9.0.11",
15+
"ts-node": "^10.9.2"
1416
},
1517
"scripts": {
1618
"dev": "npm --prefix packages/diracx-web run dev",

packages/diracx-web-components/package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@
77
"access": "public"
88
},
99
"scripts": {
10-
"build": "tsup --minify",
10+
"build": "node script/generateDocs && tsc --minify",
1111
"dev": "tsup --watch",
1212
"test": "jest --ci",
1313
"lint": "eslint ./src",
1414
"lint-staged": "lint-staged",
1515
"ts-lint": "tsc -noEmit -incremental",
1616
"prepack": "rm -rf dist && npm run build",
1717
"doc": "storybook dev -p 6006",
18-
"build-doc": "storybook build"
18+
"build-doc": "storybook build",
19+
"generate-docs": "node script/generateDocs.js"
1920
},
2021
"license": "GPL-3.0",
2122
"type": "module",
@@ -36,6 +37,7 @@
3637
"@types/react-dom": "^18.3.1",
3738
"dayjs": "^1.11.13",
3839
"mui-markdown": "^2.0.1",
40+
"node-emoji": "^2.2.0",
3941
"react": "^18.3.1",
4042
"react-dom": "^18.3.1",
4143
"react-virtuoso": "^4.12.3",

0 commit comments

Comments
 (0)