Skip to content

Commit 9d409b3

Browse files
committed
Host typedoc on netlify #707
1 parent 4ec45a5 commit 9d409b3

File tree

12 files changed

+6699
-207
lines changed

12 files changed

+6699
-207
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ Front-end for Atomic-Server, built with React.
408408

409409
Library with `Store`, `Commit`, `JSON-AD` parsing, and more.
410410

411-
[**docs**](https://atomicdata-dev.github.io/atomic-data-browser/docs/modules/_tomic_lib.html)
411+
[**docs**](https://atomic-lib.netlify.app/modules/_tomic_lib)
412412

413413
### [`@tomic/react`](browser/react/README.md)
414414

@@ -424,7 +424,7 @@ Library with `Store`, `Commit`, `JSON-AD` parsing, and more.
424424

425425
React library with many useful hooks for rendering and editing Atomic Data.
426426

427-
[**docs**](https://atomicdata-dev.github.io/atomic-data-browser/docs/modules/_tomic_react.html)
427+
[**docs**](https://atomic-lib.netlify.app/modules/_tomic_react)
428428

429429
## Also check out
430430

browser/DOCS.MD

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## Atomic Data Typescript (@tomic) Docs
22

3-
Documentation for `@tomic/lib` and `@tomic/react`.
3+
Documentation for [`@tomic/lib`](/modules/_tomic_lib) and [`@tomic/react`](/modules/_tomic_react).
4+
5+
Hosted on [atomic-lib.netlify.app](https://atomic-lib.netlify.app/)
46

57
See [the Github repository](https://github.com/atomicdata-dev/atomic-data-browser) for more information and issues.

browser/Earthfile

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,11 @@ PROJECT ontola/atomic-server
33
FROM node:20.8.0-bookworm
44
WORKDIR browser
55

6-
pipeline:
7-
PIPELINE --push
8-
TRIGGER push develop
9-
TRIGGER push main
10-
TRIGGER pr develop
11-
ARG tag=latest
12-
BUILD +test
13-
BUILD +lint
14-
BUILD +build --tag=$tag
15-
166
all:
177
BUILD +build
188
BUILD +test
199
BUILD +lint
10+
BUILD +typedoc
2011

2112
deps:
2213
RUN curl -f https://get.pnpm.io/v6.14.js | node - add --global pnpm
@@ -41,3 +32,7 @@ build:
4132
FROM +deps
4233
RUN pnpm run build
4334
SAVE ARTIFACT ./data-browser/dist
35+
36+
typedoc:
37+
FROM +build
38+
RUN pnpm run typedoc-publish

browser/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pnpm start # run the server!
3838

3939
Library with `Store`, `Commit`, `JSON-AD` parsing, and more.
4040

41-
[**docs**](https://atomicdata-dev.github.io/atomic-data-browser/docs/modules/_tomic_lib.html)
41+
[**docs**](https://atomic-lib.netlify.app/modules/_tomic_lib)
4242

4343
[→ Read more](lib/README.md)
4444

@@ -59,7 +59,7 @@ React library with many useful hooks for rendering and editing Atomic Data.
5959

6060
[**demo + template on codesandbox**](https://codesandbox.io/s/atomic-data-react-template-4y9qu?file=/src/MyResource.tsx:0-1223)
6161

62-
[**docs**](https://atomicdata-dev.github.io/atomic-data-browser/docs/modules/_tomic_react.html)
62+
[**docs**](https://atomic-lib.netlify.app/modules/_tomic_react)
6363

6464
[→ Read more](react/README.md)
6565

browser/lib/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# @tomic/lib: The Atomic Data library for typescript / javascript
22

3-
[**docs**](https://atomicdata-dev.github.io/atomic-data-browser/docs/modules/_tomic_lib.html)
3+
[**docs**](https://atomic-lib.netlify.app/modules/_tomic_lib)
44

55
Core typescript library for handling JSON-AD parsing, storing [Atomic Data](https://docs.atomicdata.dev/), signing Commits, and more.

browser/lib/package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
2-
"version": "0.36.0",
32
"author": "Joep Meindertsma",
43
"dependencies": {
54
"@noble/ed25519": "1.6.0",
@@ -10,36 +9,37 @@
109
},
1110
"description": "",
1211
"devDependencies": {
12+
"@tomic/cli": "workspace:*",
1313
"@types/fast-json-stable-stringify": "^2.1.0",
1414
"chai": "^4.3.4",
1515
"typescript": "^4.8",
16-
"whatwg-fetch": "^3.6.2",
17-
"@tomic/cli": "workspace:*"
16+
"whatwg-fetch": "^3.6.2"
1817
},
1918
"files": [
2019
"dist"
2120
],
21+
"gitHead": "2172c73d8df4e5f273e6386676abc91b6c5b2707",
2222
"license": "MIT",
23-
"main-dev": "src/index.ts",
2423
"main": "dist/src/index.js",
24+
"main-dev": "src/index.ts",
2525
"name": "@tomic/lib",
2626
"publishConfig": {
2727
"access": "public"
2828
},
2929
"scripts": {
3030
"build": "tsc",
31+
"generate-ontologies": "ad-generate ontologies",
3132
"lint": "eslint ./src --ext .js,.jsx,.ts,.tsx",
3233
"lint-fix": "eslint ./src --ext .js,.jsx,.ts,.tsx --fix",
3334
"prepublishOnly": "pnpm run build && pnpm run lint-fix",
34-
"watch": "tsc --build --watch",
3535
"start": "pnpm watch",
3636
"test": "NODE_OPTIONS='--experimental-vm-modules' ../node_modules/jest/bin/jest.js",
3737
"tsc": "tsc --build",
3838
"typecheck": "tsc --noEmit",
39-
"generate-ontologies": "ad-generate ontologies"
39+
"watch": "tsc --build --watch"
4040
},
4141
"source": "src/index.ts",
4242
"type": "module",
4343
"types": "dist/src/index.d.ts",
44-
"gitHead": "2172c73d8df4e5f273e6386676abc91b6c5b2707"
44+
"version": "0.36.0"
4545
}

browser/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
"eslint-plugin-react-hooks": "^4.3.0",
2121
"husky": "^8.0.3",
2222
"jest": "^29.0.2",
23+
"netlify-cli": "16.2.0",
2324
"prettier": "2.4.1",
2425
"prettier-plugin-jsdoc": "^0.3.24",
2526
"react": "^18.2.0",
@@ -42,7 +43,8 @@
4243
"test-e2e": "pnpm run --filter @tomic/e2e test-e2e",
4344
"test-query": "pnpm run --filter @tomic/e2e test-query",
4445
"start": "pnpm run -r --parallel start",
45-
"typedoc": "typedoc . --options typedoc.json",
46+
"typedoc": "typedoc --options ./typedoc.json",
47+
"typedoc-publish": "pnpm run typedoc && netlify deploy --dir data-browser/publish/docs/ --prod --auth $NETLIFY_AUTH_TOKEN --site atomic-lib",
4648
"typecheck": "pnpm run -r --parallel typecheck"
4749
},
4850
"husky": {

0 commit comments

Comments
 (0)