PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
tldraw/apps/docs/package.json

79 lines
2.2 KiB
JSON
Raw Normal View History

transfer-out: transfer out
2023-04-25 11:01:25 +00:00
{
"name": "@tldraw/docs",
"description": "A docs site for tldraw.",
"version": "0.1.1-alpha.0",
"private": true,
"packageManager": "yarn@3.5.0",
"author": {
"name": "tldraw GB Ltd.",
"email": "hello@tldraw.com"
},
"homepage": "https://tldraw.dev",
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "https://github.com/tldraw/tldraw"
},
"bugs": {
"url": "https://github.com/tldraw/tldraw/issues"
},
"keywords": [
"tldraw",
"drawing",
"app",
"development",
"whiteboard",
"canvas",
"infinite"
],
"scripts": {
Auto content refresh for docs site (#1606) This PR improves the author experience when working on the docs site. When running `docs-dev`, the site's content will now update whenever a content file is changed. ### Context In the docs project, we generate content from two sources: from API documentation generated by api-extractor and from markdown files in the docs/content folder. Generating API docs is a relatively slow process because it involves building and parsing TypeScript declaration files for each package in the monorepo; however, generating docs from the markdown files is basically instantaneous. The same script used to address both tasks, which meant it was too slow to run on each save. Instead, the script needed to be run manually or the dev server would need to be restarted. We now split the generation into two separate scripts. First, the script runs to generate the API content; and then a second script runs to generate the markdown content. The second script also imports and combines the two sources of content. When we build the docs, both scripts are run. When a markdown file changes, the new watcher only runs the second script. This allows the site's content to be updated quickly without having to generate the API docs each time. Note that this does not incorporate live changes to package APIs, though I can't think of a time where we be developing the docs and the APIs at the same time. ### Change Type - [x] `documentation` — Changes to the documentation only
2023-06-17 09:46:46 +00:00
"dev": "yarn docs-content && NODE_ENV=development next-remote-watch ./content/**/*.mdx -c 'yarn run -T tsx ./scripts/generate-on-reload.ts'",
avoid lazy race conditions (#1364) We had a few issues with lazy race conditions failing CI. This came from scripts configured to invoke lazy again, rather than through expressing dependencies between scripts. This diff reconfigures lazy to articulate these sorts of things as dependencies instead of through self-invocation. Instead of having lots of separate `build-package`, `build-docs`, etc commands, we now just have a build command with package overrides to express more specific options ### Change Type - [x] `internal` — Any other changes that don't affect the published package (will not publish a new version) ### Release Notes [internal only]
2023-05-12 15:41:40 +00:00
"build": "next build",
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
"start": "next start",
"lint": "yarn run -T tsx ../../scripts/lint.ts",
[chore] update lazyrepo (#1211)
2023-05-02 12:25:26 +00:00
"docs-content": "ts-node --project tsconfig.content.json ./scripts/index.ts",
"content": "lazy docs-content"
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
},
"dependencies": {
"@microsoft/tsdoc": "^0.14.2",
"@tldraw/utils": "workspace:*",
"@types/node": "18.15.0",
"@types/react": "^18.0.24",
"@types/react-dom": "^18.0.6",
Revert "Update dependencies (#1613)" (#1617) This reverts commit b6716a3750879502dbd9f912e8d19fa37f64a634. Not sure why, but this introduced a `/// <references />` comment in the tldraw/tldraw api-report.md file that doesn't show up when you build from brivate. Reverting for now. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1] ### Test Plan - ### Release Notes -
2023-06-19 09:49:44 +00:00
"eslint": "8.36.0",
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
"eslint-config-next": "13.2.4",
"gray-matter": "^4.0.3",
"next": "13.2.4",
"next-mdx-remote": "^4.4.1",
"next-remote-watch": "^2.0.0",
"next-themes": "^0.2.1",
"prettier": "^2.8.7",
Revert "Update dependencies (#1613)" (#1617) This reverts commit b6716a3750879502dbd9f912e8d19fa37f64a634. Not sure why, but this introduced a `/// <references />` comment in the tldraw/tldraw api-report.md file that doesn't show up when you build from brivate. Reverting for now. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1] ### Test Plan - ### Release Notes -
2023-06-19 09:49:44 +00:00
"react": "18.2.0",
"react-dom": "18.2.0",
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
"rehype-autolink-headings": "^6.1.1",
"rehype-highlight": "^6.0.0",
"rehype-slug": "^5.1.0",
"rehype-slug-custom-id": "^1.1.0",
"remark-gfm": "^3.0.1"
},
Remove `@tldraw/utils` from the docs site (#1596) This PR removes the `@tldraw/utils` package from the docs site's API reference. It does this by removing it from the docs site's `devDependencies`. The reason for this is this: <img width="899" alt="Screenshot 2023-06-15 at 15 52 24" src="https://github.com/tldraw/tldraw/assets/15892272/3b00e9da-663d-45e5-8b77-ab0a4fc466ad"> ### Change Type - [x] `documentation` — Changes to the documentation only[^2] [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Check the API Reference page of the docs. 2. Make that `@tldraw/utils` isn't there. ### Release Notes - [docs] Removed an internal utilities package.
2023-06-15 15:35:23 +00:00
"//": [
"Anything that starts with @tldraw in devDependencies will get included in the docs site.",
"We have to list them here so lazyrepo knows the docs depends on those packages (ie their",
"tsdoc comments), even though we don't use any of their code to run the docs site."
],
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
"devDependencies": {
Revert "Update dependencies (#1613)" (#1617) This reverts commit b6716a3750879502dbd9f912e8d19fa37f64a634. Not sure why, but this introduced a `/// <references />` comment in the tldraw/tldraw api-report.md file that doesn't show up when you build from brivate. Reverting for now. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1] ### Test Plan - ### Release Notes -
2023-06-19 09:49:44 +00:00
"@microsoft/api-extractor-model": "^7.26.4",
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
"@tldraw/editor": "workspace:*",
"@tldraw/file-format": "workspace:*",
"@tldraw/primitives": "workspace:*",
Rename tlstore to store (#1507) This PR renames the `@tldraw/tlstore` package to `@tldraw/store`, mainly to avoid confusion between `TLStore`. Will be doing the same with other packages. ### Change Type - [x] `major` — Breaking Change ### Release Notes - Replace @tldraw/tlstore with @tldraw/store
2023-06-03 08:59:04 +00:00
"@tldraw/store": "workspace:*",
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
"@tldraw/tldraw": "workspace:*",
"@tldraw/tlschema": "workspace:*",
"@tldraw/ui": "workspace:*",
Rename tlvalidate to validate (#1508) This PR renames the @tldraw/tlvalidate package to @tldraw/validate. ### Change Type - [x] `major` — Breaking Change ### Release Notes - Rename tlvalidate to validate
2023-06-03 08:27:44 +00:00
"@tldraw/validate": "workspace:*",
update lazyrepo
2023-06-05 17:32:32 +00:00
"lazyrepo": "0.0.0-alpha.27",
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
"rimraf": "^4.4.0",
"ts-node": "^10.9.1"
}
}
Reference in a new issue Copy permalink