From 0987e9267664da84e3b43c2c02c325691d330c8a Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Sun, 24 Apr 2022 11:26:06 +0100 Subject: [PATCH 01/13] feat: docs website --- package.json | 116 +- packages/dockview-docs/.eslintrc.json | 3 + packages/dockview-docs/.gitignore | 35 + packages/dockview-docs/README.md | 34 + .../dockview-docs/jsexamples/dockview.html | 27 + packages/dockview-docs/next-env.d.ts | 5 + packages/dockview-docs/next.config.mjs | 38 + packages/dockview-docs/package-lock.json | 8783 +++++++++++++++++ packages/dockview-docs/package.json | 37 + packages/dockview-docs/public/favicon.ico | Bin 0 -> 25931 bytes packages/dockview-docs/public/icon-link.svg | 1 + packages/dockview-docs/public/vercel.svg | 4 + .../dockview-docs/src/components/code.tsx | 70 + .../src/components/container.tsx | 19 + .../dockview-docs/src/components/footer.tsx | 7 + .../dockview-docs/src/components/header.tsx | 46 + .../src/components/navigation.tsx | 88 + .../src/components/simpleSplitview.tsx | 49 + .../dockview-docs/src/components/test.tsx | 5 + packages/dockview-docs/src/pages/_app.tsx | 33 + .../dockview-docs/src/pages/_document.tsx | 28 + packages/dockview-docs/src/pages/about.tsx | 12 + packages/dockview-docs/src/pages/basics.tsx | 9 + packages/dockview-docs/src/pages/index.mdx | 130 + .../dockview-docs/src/references/pages.ts | 49 + packages/dockview-docs/src/styles/globals.css | 43 + .../dockview-docs/src/styles/navigation.css | 45 + packages/dockview-docs/src/test.tsx | 79 + packages/dockview-docs/tsconfig.json | 24 + 29 files changed, 9761 insertions(+), 58 deletions(-) create mode 100644 packages/dockview-docs/.eslintrc.json create mode 100644 packages/dockview-docs/.gitignore create mode 100644 packages/dockview-docs/README.md create mode 100644 packages/dockview-docs/jsexamples/dockview.html create mode 100644 packages/dockview-docs/next-env.d.ts create mode 100644 packages/dockview-docs/next.config.mjs create mode 100644 packages/dockview-docs/package-lock.json create mode 100644 packages/dockview-docs/package.json create mode 100644 packages/dockview-docs/public/favicon.ico create mode 100644 packages/dockview-docs/public/icon-link.svg create mode 100644 packages/dockview-docs/public/vercel.svg create mode 100644 packages/dockview-docs/src/components/code.tsx create mode 100644 packages/dockview-docs/src/components/container.tsx create mode 100644 packages/dockview-docs/src/components/footer.tsx create mode 100644 packages/dockview-docs/src/components/header.tsx create mode 100644 packages/dockview-docs/src/components/navigation.tsx create mode 100644 packages/dockview-docs/src/components/simpleSplitview.tsx create mode 100644 packages/dockview-docs/src/components/test.tsx create mode 100644 packages/dockview-docs/src/pages/_app.tsx create mode 100644 packages/dockview-docs/src/pages/_document.tsx create mode 100644 packages/dockview-docs/src/pages/about.tsx create mode 100644 packages/dockview-docs/src/pages/basics.tsx create mode 100644 packages/dockview-docs/src/pages/index.mdx create mode 100644 packages/dockview-docs/src/references/pages.ts create mode 100644 packages/dockview-docs/src/styles/globals.css create mode 100644 packages/dockview-docs/src/styles/navigation.css create mode 100644 packages/dockview-docs/src/test.tsx create mode 100644 packages/dockview-docs/tsconfig.json diff --git a/package.json b/package.json index 7f6bdb658..31cea6df5 100644 --- a/package.json +++ b/package.json @@ -1,60 +1,60 @@ { - "name": "dockview-monorepo-root", - "private": true, - "description": "Monorepo for https://github.com/mathuo/dockview", - "scripts": { - "test": "jest", - "lint": "eslint packages/**/src/** --ext .ts,.tsx,.js,.jsx", - "package": "node scripts/package.js", - "package-all": "npm run build-demo && npm run docs && node scripts/package.js", - "build": "lerna run build --ignore dockview-demo", - "build-demo": "lerna run build --scope dockview-demo", - "docs": "lerna run docs --scope dockview", - "clean": "lerna run clean", - "bootstrap": "lerna bootstrap", - "bootstrap-no-hoist": "lerna bootstrap", - "test:cov": "jest --coverage", - "version-beta-build": "lerna version prerelease --preid beta", - "publish-app": "lerna publish" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/mathuo/dockview.git" - }, - "author": "https://github.com/mathuo", - "license": "MIT", - "bugs": { - "url": "https://github.com/mathuo/dockview/issues" - }, - "homepage": "https://github.com/mathuo/dockview#readme", - "devDependencies": { - "@testing-library/dom": "^8.13.0", - "@types/jest": "^27.4.1", - "@typescript-eslint/eslint-plugin": "^5.19.0", - "@typescript-eslint/parser": "^5.19.0", - "codecov": "^3.8.3", - "cross-env": "^7.0.3", - "css-loader": "^6.7.1", - "eslint": "^8.13.0", - "fs-extra": "^10.0.1", - "gulp": "^4.0.2", - "gulp-concat": "^2.6.1", - "gulp-dart-sass": "^1.0.2", - "jest": "^27.5.1", - "jest-sonar-reporter": "^2.0.0", - "jsdom": "^19.0.0", - "lerna": "^4.0.0", - "merge2": "^1.4.1", - "rimraf": "^3.0.2", - "sass": "^1.50.0", - "sass-loader": "^12.6.0", - "style-loader": "^3.3.1", - "ts-jest": "^27.1.4", - "ts-loader": "^9.2.8", - "tslib": "^2.3.1", - "typescript": "^4.6.3", - "webpack": "^5.72.0", - "webpack-cli": "^4.9.2", - "webpack-dev-server": "^4.8.1" - } + "name": "dockview-monorepo-root", + "private": true, + "description": "Monorepo for https://github.com/mathuo/dockview", + "scripts": { + "test": "jest", + "lint": "eslint packages/**/src/** --ext .ts,.tsx,.js,.jsx", + "package": "node scripts/package.js", + "package-all": "npm run build-demo && npm run docs && node scripts/package.js", + "build": "lerna run build --scope dockview", + "build-demo": "lerna run build --scope dockview-demo", + "docs": "lerna run docs --scope dockview", + "clean": "lerna run clean", + "bootstrap": "lerna bootstrap", + "bootstrap-no-hoist": "lerna bootstrap", + "test:cov": "jest --coverage", + "version-beta-build": "lerna version prerelease --preid beta", + "publish-app": "lerna publish" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/mathuo/dockview.git" + }, + "author": "https://github.com/mathuo", + "license": "MIT", + "bugs": { + "url": "https://github.com/mathuo/dockview/issues" + }, + "homepage": "https://github.com/mathuo/dockview#readme", + "devDependencies": { + "@testing-library/dom": "^8.13.0", + "@types/jest": "^27.4.1", + "@typescript-eslint/eslint-plugin": "^5.19.0", + "@typescript-eslint/parser": "^5.19.0", + "codecov": "^3.8.3", + "cross-env": "^7.0.3", + "css-loader": "^6.7.1", + "eslint": "^8.13.0", + "fs-extra": "^10.0.1", + "gulp": "^4.0.2", + "gulp-concat": "^2.6.1", + "gulp-dart-sass": "^1.0.2", + "jest": "^27.5.1", + "jest-sonar-reporter": "^2.0.0", + "jsdom": "^19.0.0", + "lerna": "^4.0.0", + "merge2": "^1.4.1", + "rimraf": "^3.0.2", + "sass": "^1.50.0", + "sass-loader": "^12.6.0", + "style-loader": "^3.3.1", + "ts-jest": "^27.1.4", + "ts-loader": "^9.2.8", + "tslib": "^2.3.1", + "typescript": "^4.6.3", + "webpack": "^5.72.0", + "webpack-cli": "^4.9.2", + "webpack-dev-server": "^4.8.1" + } } diff --git a/packages/dockview-docs/.eslintrc.json b/packages/dockview-docs/.eslintrc.json new file mode 100644 index 000000000..bffb357a7 --- /dev/null +++ b/packages/dockview-docs/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "next/core-web-vitals" +} diff --git a/packages/dockview-docs/.gitignore b/packages/dockview-docs/.gitignore new file mode 100644 index 000000000..737d87210 --- /dev/null +++ b/packages/dockview-docs/.gitignore @@ -0,0 +1,35 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* +.pnpm-debug.log* + +# local env files +.env*.local + +# vercel +.vercel + +# typescript +*.tsbuildinfo diff --git a/packages/dockview-docs/README.md b/packages/dockview-docs/README.md new file mode 100644 index 000000000..c87e0421d --- /dev/null +++ b/packages/dockview-docs/README.md @@ -0,0 +1,34 @@ +This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). + +## Getting Started + +First, run the development server: + +```bash +npm run dev +# or +yarn dev +``` + +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. + +You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. + +[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. + +The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. + +## Learn More + +To learn more about Next.js, take a look at the following resources: + +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. + +You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! + +## Deploy on Vercel + +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. + +Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. diff --git a/packages/dockview-docs/jsexamples/dockview.html b/packages/dockview-docs/jsexamples/dockview.html new file mode 100644 index 000000000..84a4e165e --- /dev/null +++ b/packages/dockview-docs/jsexamples/dockview.html @@ -0,0 +1,27 @@ + + +
+ + + + + + + + + + + diff --git a/packages/dockview-docs/next-env.d.ts b/packages/dockview-docs/next-env.d.ts new file mode 100644 index 000000000..4f11a03dc --- /dev/null +++ b/packages/dockview-docs/next-env.d.ts @@ -0,0 +1,5 @@ +///
+ {children}
+
+ );
+ }
+
+ const language = className.replace(/language-/, '');
+
+ return (
+ + {tokens.map((line, i) => ( ++ )} ++ {line.map((token, key) => ( + + ))} ++ ))} +