3ae48af67c
This PR starts putting in place the high-level changes we want to make to the docs site. - It makes separate sections for Reference and Examples and Community. - Gets rid of the secondary sidebar and integrates it into the main sidebar. - Groups the reference articles by type. - Pulls in the examples alongside code and a live playground so people don't have to visit examples.tldraw.com separately. <img width="1458" alt="Screenshot 2024-01-30 at 09 43 46" src="https://github.com/tldraw/tldraw/assets/469604/4f5aa339-3a69-4d9b-9b9f-dfdddea623e8"> Again, this is the top-level changes and there's more to be done for the next PR(s): - create quick start page - clean up installation page - add accordion to Examples page prbly - put fun stuff in header (from footer) - landing page - something for landing page of API - search cmd-k and border - cleanup _sidebarReferenceContentLinks - external links _blank - address potential skew issue with code examples - have a link to other examples (next.js, etc.) ### Change Type - [x] `documentation` — Changes to the documentation only[^2] ### Test Plan 1. Make sure examples work! ### Release Notes - Rework our docs site to pull together the examples app and reference section more cohesively. --------- Co-authored-by: Taha <98838967+Taha-Hassan-Git@users.noreply.github.com> Co-authored-by: Steve Ruiz <steveruizok@gmail.com> Co-authored-by: Mitja Bezenšek <mitja.bezensek@gmail.com> Co-authored-by: alex <alex@dytry.ch> Co-authored-by: Lu Wilson <l2wilson94@gmail.com> Co-authored-by: Dan Groshev <git@dgroshev.com>
90 lines
3 KiB
JSON
90 lines
3 KiB
JSON
{
|
|
"name": "@tldraw/docs",
|
|
"description": "A docs site for tldraw.",
|
|
"version": "2.0.0-beta.2",
|
|
"private": true,
|
|
"author": {
|
|
"name": "tldraw Inc.",
|
|
"email": "hello@tldraw.com"
|
|
},
|
|
"homepage": "https://tldraw.dev",
|
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
"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": {
|
|
"dev": "concurrently \"NODE_ENV=development next dev --port=3001\" \"tsx ./watcher.ts\" --kill-others",
|
|
"next-dev": "next dev",
|
|
"lint": "yarn run -T tsx ../../scripts/lint.ts",
|
|
"build": "yarn create-api-markdown && yarn refresh-content && next build",
|
|
"start": "yarn create-api-markdown && yarn refresh-content && next start",
|
|
"fetch-api-source": "yarn run -T tsx --tsconfig ./tsconfig.content.json ./scripts/fetch-api-source.ts",
|
|
"fetch-releases": "yarn run -T tsx --tsconfig ./tsconfig.content.json ./scripts/fetch-releases.ts",
|
|
"check-links": "yarn run -T tsx --tsconfig ./tsconfig.content.json ./scripts/check-broken-links.ts",
|
|
"create-api-markdown": "yarn run -T tsx --tsconfig ./tsconfig.content.json ./scripts/create-api-markdown.ts",
|
|
"refresh-content": "yarn run -T tsx --tsconfig ./tsconfig.content.json ./scripts/refresh-content.ts",
|
|
"refresh-embeddings": "yarn run -T tsx --tsconfig ./tsconfig.content.json ./scripts/refresh-embeddings.ts",
|
|
"refresh-everything": "yarn fetch-api-source && yarn fetch-releases && yarn create-api-markdown && yarn refresh-content && yarn refresh-embeddings && yarn format",
|
|
"clean": "rm -rf node_modules .yarn",
|
|
"format": "yarn run -T prettier --write .",
|
|
"watch-content": "tsx ./watcher.ts"
|
|
},
|
|
"dependencies": {
|
|
"@codesandbox/sandpack-react": "^2.11.3",
|
|
"@microsoft/api-extractor-model": "^7.26.4",
|
|
"@microsoft/tsdoc": "^0.14.2",
|
|
"@radix-ui/react-accordion": "^1.1.2",
|
|
"@radix-ui/react-navigation-menu": "^1.1.4",
|
|
"@types/broken-link-checker": "^0.7.1",
|
|
"@types/node": "^18.7.3",
|
|
"@types/sqlite3": "^3.1.9",
|
|
"@types/ws": "^8.5.9",
|
|
"@vercel/analytics": "^1.1.1",
|
|
"broken-link-checker": "^0.7.8",
|
|
"classnames": "^2.3.2",
|
|
"concurrently": "^8.2.2",
|
|
"dotenv": "^16.3.1",
|
|
"eslint": "^8.37.0",
|
|
"eslint-config-next": "13.2.4",
|
|
"github-slugger": "^2.0.0",
|
|
"gray-matter": "^4.0.3",
|
|
"next": "^14.0.4",
|
|
"next-mdx-remote": "^4.4.1",
|
|
"next-themes": "^0.2.1",
|
|
"octokit": "^3.1.1",
|
|
"openai": "^4.11.1",
|
|
"patch-package": "^8.0.0",
|
|
"postinstall-postinstall": "^2.1.0",
|
|
"prettier": "^3.0.3",
|
|
"prettier-plugin-organize-imports": "^3.2.3",
|
|
"react": "^18.2.0",
|
|
"react-dom": "^18.2.0",
|
|
"react-hotkeys-hook": "^4.4.1",
|
|
"rehype-autolink-headings": "^7.0.0",
|
|
"rehype-highlight": "^7.0.0",
|
|
"rehype-slug": "^5.1.0",
|
|
"rehype-slug-custom-id": "^1.1.0",
|
|
"rimraf": "^4.4.0",
|
|
"sqlite": "^5.0.1",
|
|
"sqlite3": "^5.1.6",
|
|
"tsx": "^4.0.0",
|
|
"typescript": "^5.2.2",
|
|
"unist-util-is": "^6.0.0",
|
|
"unist-util-visit": "^5.0.0",
|
|
"vectra": "^0.4.4",
|
|
"ws": "^8.16.0"
|
|
}
|
|
}
|