From 8ba3d2531e86a3f4b324c1546c09389f6a676412 Mon Sep 17 00:00:00 2001 From: Steve Genoud Date: Tue, 14 Feb 2023 11:26:25 +0100 Subject: [PATCH] Update the API docs --- .../docs/examples/design-watering-can.mdx | 2 +- packages/replicad-docs/docs/intro.md | 2 +- .../docs/tutorial-basics/_category_.json | 4 -- .../docs/tutorial-overview/_category_.json | 4 ++ .../adding-depth.md | 0 .../combinations.md | 0 .../drawing.md | 0 .../finders.md | 0 .../modifications.md | 0 .../planes-and-sketches.md | 0 .../sharing-models.md | 0 .../transformations.md | 0 .../using-the-workbench.md | 0 packages/replicad-docs/docusaurus.config.js | 1 + packages/replicad-docs/package.json | 8 +-- packages/replicad/package.json | 2 +- packages/replicad/src/text.ts | 4 -- packages/replicad/tsconfig.json | 40 ++++++++--- yarn.lock | 71 +++++++++++++++---- 19 files changed, 103 insertions(+), 35 deletions(-) delete mode 100644 packages/replicad-docs/docs/tutorial-basics/_category_.json create mode 100644 packages/replicad-docs/docs/tutorial-overview/_category_.json rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/adding-depth.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/combinations.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/drawing.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/finders.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/modifications.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/planes-and-sketches.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/sharing-models.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/transformations.md (100%) rename packages/replicad-docs/docs/{tutorial-basics => tutorial-overview}/using-the-workbench.md (100%) diff --git a/packages/replicad-docs/docs/examples/design-watering-can.mdx b/packages/replicad-docs/docs/examples/design-watering-can.mdx index 2d8e7f3..273df6f 100644 --- a/packages/replicad-docs/docs/examples/design-watering-can.mdx +++ b/packages/replicad-docs/docs/examples/design-watering-can.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 7 -title: Design watering can +title: Watering can --- import CodeBlock from '@theme/CodeBlock'; diff --git a/packages/replicad-docs/docs/intro.md b/packages/replicad-docs/docs/intro.md index 2f51e61..648e1a9 100644 --- a/packages/replicad-docs/docs/intro.md +++ b/packages/replicad-docs/docs/intro.md @@ -23,7 +23,7 @@ As of now, there is only a simple online workbench to play with the replicad API and draw a 3D model. You can use [the workbench](https://studio.replicad.xyz/workbench) to follow [the -tutorial](/docs/tutorial-basics/using-the-workbench) +tutorial](/docs/tutorial-overview/using-the-workbench) ## Integrating replicad in your web application diff --git a/packages/replicad-docs/docs/tutorial-basics/_category_.json b/packages/replicad-docs/docs/tutorial-basics/_category_.json deleted file mode 100644 index 711734d..0000000 --- a/packages/replicad-docs/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Basics", - "position": 2 -} diff --git a/packages/replicad-docs/docs/tutorial-overview/_category_.json b/packages/replicad-docs/docs/tutorial-overview/_category_.json new file mode 100644 index 0000000..fbe9f1e --- /dev/null +++ b/packages/replicad-docs/docs/tutorial-overview/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Overview", + "position": 2 +} diff --git a/packages/replicad-docs/docs/tutorial-basics/adding-depth.md b/packages/replicad-docs/docs/tutorial-overview/adding-depth.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/adding-depth.md rename to packages/replicad-docs/docs/tutorial-overview/adding-depth.md diff --git a/packages/replicad-docs/docs/tutorial-basics/combinations.md b/packages/replicad-docs/docs/tutorial-overview/combinations.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/combinations.md rename to packages/replicad-docs/docs/tutorial-overview/combinations.md diff --git a/packages/replicad-docs/docs/tutorial-basics/drawing.md b/packages/replicad-docs/docs/tutorial-overview/drawing.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/drawing.md rename to packages/replicad-docs/docs/tutorial-overview/drawing.md diff --git a/packages/replicad-docs/docs/tutorial-basics/finders.md b/packages/replicad-docs/docs/tutorial-overview/finders.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/finders.md rename to packages/replicad-docs/docs/tutorial-overview/finders.md diff --git a/packages/replicad-docs/docs/tutorial-basics/modifications.md b/packages/replicad-docs/docs/tutorial-overview/modifications.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/modifications.md rename to packages/replicad-docs/docs/tutorial-overview/modifications.md diff --git a/packages/replicad-docs/docs/tutorial-basics/planes-and-sketches.md b/packages/replicad-docs/docs/tutorial-overview/planes-and-sketches.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/planes-and-sketches.md rename to packages/replicad-docs/docs/tutorial-overview/planes-and-sketches.md diff --git a/packages/replicad-docs/docs/tutorial-basics/sharing-models.md b/packages/replicad-docs/docs/tutorial-overview/sharing-models.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/sharing-models.md rename to packages/replicad-docs/docs/tutorial-overview/sharing-models.md diff --git a/packages/replicad-docs/docs/tutorial-basics/transformations.md b/packages/replicad-docs/docs/tutorial-overview/transformations.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/transformations.md rename to packages/replicad-docs/docs/tutorial-overview/transformations.md diff --git a/packages/replicad-docs/docs/tutorial-basics/using-the-workbench.md b/packages/replicad-docs/docs/tutorial-overview/using-the-workbench.md similarity index 100% rename from packages/replicad-docs/docs/tutorial-basics/using-the-workbench.md rename to packages/replicad-docs/docs/tutorial-overview/using-the-workbench.md diff --git a/packages/replicad-docs/docusaurus.config.js b/packages/replicad-docs/docusaurus.config.js index cff8f9e..6138b70 100644 --- a/packages/replicad-docs/docusaurus.config.js +++ b/packages/replicad-docs/docusaurus.config.js @@ -104,6 +104,7 @@ const config = { entryPoints: ["../replicad/src/index.ts"], tsconfig: "../replicad/tsconfig.json", watch: process.env.TYPEDOC_WATCH, + sidebar: { position: 100 }, }, ], ], diff --git a/packages/replicad-docs/package.json b/packages/replicad-docs/package.json index d07136b..f39e23c 100644 --- a/packages/replicad-docs/package.json +++ b/packages/replicad-docs/package.json @@ -19,7 +19,7 @@ "@mdx-js/react": "^1.6.21", "@svgr/webpack": "^5.5.0", "clsx": "^1.1.1", - "docusaurus-plugin-typedoc": "^0.17.2", + "docusaurus-plugin-typedoc": "^0.18.0", "file-loader": "^6.2.0", "jszip": "^3.10.1", "prism-react-renderer": "^1.2.1", @@ -41,8 +41,8 @@ ] }, "devDependencies": { - "typedoc": "^0.22.7", - "typedoc-plugin-markdown": "^3.11.10", - "typescript": "^4.4.4" + "typedoc": "^0.23.25", + "typedoc-plugin-markdown": "^3.14.0", + "typescript": "^4.9.5" } } diff --git a/packages/replicad/package.json b/packages/replicad/package.json index f2c7896..32d3c97 100644 --- a/packages/replicad/package.json +++ b/packages/replicad/package.json @@ -57,7 +57,7 @@ "rollup-plugin-terser": "^7.0.2", "rollup-plugin-ts": "3.1.1", "typedoc": "^0.22.7", - "typescript": "^4.9.4", + "typescript": "^4.9.5", "vite": "^4.0.4", "vite-plugin-dts": "^1.7.1", "vitest": "^0.28.3" diff --git a/packages/replicad/src/text.ts b/packages/replicad/src/text.ts index ad85308..0f1cff4 100644 --- a/packages/replicad/src/text.ts +++ b/packages/replicad/src/text.ts @@ -83,8 +83,6 @@ const sketchFontCommands = function* (commands: opentype.PathCommand[]) { /** * Creates the `Blueprints` of a text, in a defined font size and a font familiy * (which will be the default). - * - * @category Blueprints */ export function textBlueprints( text: string, @@ -99,8 +97,6 @@ export function textBlueprints( /** * Creates the `Sketches` of a text, in a defined font size and a font familiy * (which will be the default). - * - * @category Sketching */ export function sketchText( text: string, diff --git a/packages/replicad/tsconfig.json b/packages/replicad/tsconfig.json index 1c9da53..f9f9874 100644 --- a/packages/replicad/tsconfig.json +++ b/packages/replicad/tsconfig.json @@ -2,20 +2,44 @@ "compilerOptions": { "moduleResolution": "node", "target": "es6", - "module":"es2015", + "module": "es2015", "strict": true, "sourceMap": true, "skipLibCheck": true, "declaration": true, "allowSyntheticDefaultImports": true }, - "include": [ - "src" - ], + "include": ["src"], "typedocOptions": { - "watch": true, - "readme": "none", - "excludeProtected": true + "watch": true, + "readme": "none", + "categoryOrder": ["Drawing", "Import", "*"], + "kindSortOrder": [ + "Function", + "Reference", + "Project", + "Module", + "Namespace", + "Enum", + "EnumMember", + "Class", + "Interface", + "TypeAlias", + "Constructor", + "Property", + "Variable", + "Accessor", + "Method", + "ObjectLiteral", + "Parameter", + "TypeParameter", + "TypeLiteral", + "CallSignature", + "ConstructorSignature", + "IndexSignature", + "GetSignature", + "SetSignature" + ], + "excludeProtected": true } } - diff --git a/yarn.lock b/yarn.lock index d3dbcae..4636f65 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5643,6 +5643,11 @@ ansi-regex@^6.0.1: resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.0.1.tgz#3183e38fae9a65d7cb5e53945cd5897d0260a06a" integrity sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA== +ansi-sequence-parser@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/ansi-sequence-parser/-/ansi-sequence-parser-1.1.0.tgz#4d790f31236ac20366b23b3916b789e1bde39aed" + integrity sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ== + ansi-styles@^3.2.1: version "3.2.1" resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" @@ -7441,10 +7446,10 @@ doctrine@^3.0.0: dependencies: esutils "^2.0.2" -docusaurus-plugin-typedoc@^0.17.2: - version "0.17.2" - resolved "https://registry.yarnpkg.com/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-0.17.2.tgz#ee3d0565604c3d4972aff9869b1de3dcf02de749" - integrity sha512-4K6kJbyUlUMR7tl2cMfCOG8E/3N0JISw7Wcx0afo0lvrXdZukDqwtpS58Nt/hBVO1s6gzSWyK+PJjseaDq0JdA== +docusaurus-plugin-typedoc@^0.18.0: + version "0.18.0" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-0.18.0.tgz#d04966c4ed843a285c72cdd641e2fb3973684f9f" + integrity sha512-kurIUu8LhVIOPT88HoeBcu0/D2GMDdg0pUYaFlqeuXT9an6Wlgvuy0C22ZMYcJUcp/gA/Mw2XdUHubsLK2M4uA== dom-converter@^0.2.0: version "0.2.0" @@ -10330,6 +10335,11 @@ marked@^3.0.8: resolved "https://registry.yarnpkg.com/marked/-/marked-3.0.8.tgz#2785f0dc79cbdc6034be4bb4f0f0a396bd3f8aeb" integrity sha512-0gVrAjo5m0VZSJb4rpL59K1unJAMb/hm8HRXqasD8VeC8m91ytDPMritgFSlKonfdt+rRYYpP/JfLxgIX8yoSw== +marked@^4.2.12: + version "4.2.12" + resolved "https://registry.yarnpkg.com/marked/-/marked-4.2.12.tgz#d69a64e21d71b06250da995dcd065c11083bebb5" + integrity sha512-yr8hSKa3Fv4D3jdZmtMMPghgVt6TWbk86WQaWhDloQjRSQhMMYCAro7jP7VDJrjjdV8pxVxMssXS8B8Y5DZ5aw== + mdast-squeeze-paragraphs@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/mdast-squeeze-paragraphs/-/mdast-squeeze-paragraphs-4.0.0.tgz#7c4c114679c3bee27ef10b58e2e015be79f1ef97" @@ -10554,6 +10564,13 @@ minimatch@^5.0.1, minimatch@^5.1.0: dependencies: brace-expansion "^2.0.1" +minimatch@^6.1.6: + version "6.2.0" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-6.2.0.tgz#2b70fd13294178c69c04dfc05aebdb97a4e79e42" + integrity sha512-sauLxniAmvnhhRjFwPNnJKaPFYyddAgbYdeUpHULtCT/GhzdCx/MDNy+Y40lBxTQUrMzDE8e0S43Z5uqfO0REg== + dependencies: + brace-expansion "^2.0.1" + minimist-options@4.1.0: version "4.1.0" resolved "https://registry.yarnpkg.com/minimist-options/-/minimist-options-4.1.0.tgz#c0655713c53a8a2ebd77ffa247d342c40f010619" @@ -13284,6 +13301,16 @@ shelljs@^0.8.5: interpret "^1.0.0" rechoir "^0.6.2" +shiki@^0.14.1: + version "0.14.1" + resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.14.1.tgz#9fbe082d0a8aa2ad63df4fbf2ee11ec924aa7ee1" + integrity sha512-+Jz4nBkCBe0mEDqo1eKRcCdjRtrCjozmcbTUjbPTX7OOJfEbTZzlUWlZtGe3Gb5oV1/jnojhG//YZc3rs9zSEw== + dependencies: + ansi-sequence-parser "^1.1.0" + jsonc-parser "^3.2.0" + vscode-oniguruma "^1.7.0" + vscode-textmate "^8.0.0" + shiki@^0.9.12: version "0.9.12" resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.9.12.tgz#70cbc8c1bb78ff7b356f84a7eecdb040efddd247" @@ -14267,10 +14294,10 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c= -typedoc-plugin-markdown@^3.11.10: - version "3.13.4" - resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.13.4.tgz#4c2f02b254c47d25b91579177900c1da5c5579b8" - integrity sha512-E/EBBmu6ARtnbswZGtBVBB/BfukZiGMOlqPc0RXCI/NFitONBahFqbCAF5fKQlijlcfipJj5pw5AMFH3NytrAw== +typedoc-plugin-markdown@^3.14.0: + version "3.14.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.14.0.tgz#17b99ee3ab0d21046d253f185f7669e80d0d7891" + integrity sha512-UyQLkLRkfTFhLdhSf3RRpA3nNInGn+k6sll2vRXjflaMNwQAAiB61SYbisNZTg16t4K1dt1bPQMMGLrxS0GZ0Q== dependencies: handlebars "^4.7.7" @@ -14285,15 +14312,25 @@ typedoc@^0.22.7: minimatch "^3.0.4" shiki "^0.9.12" +typedoc@^0.23.25: + version "0.23.25" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.23.25.tgz#5f8f1850fd044c4d15d453117affddf11a265610" + integrity sha512-O1he153qVyoCgJYSvIyY3bPP1wAJTegZfa6tL3APinSZhJOf8CSd8F/21M6ex8pUY/fuY6n0jAsT4fIuMGA6sA== + dependencies: + lunr "^2.3.9" + marked "^4.2.12" + minimatch "^6.1.6" + shiki "^0.14.1" + typescript@^4.4.4: version "4.4.4" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.4.tgz#2cd01a1a1f160704d3101fd5a58ff0f9fcb8030c" integrity sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA== -typescript@^4.9.4: - version "4.9.4" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.4.tgz#a2a3d2756c079abda241d75f149df9d561091e78" - integrity sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg== +typescript@^4.9.5: + version "4.9.5" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.5.tgz#095979f9bcc0d09da324d58d03ce8f8374cbe65a" + integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g== typescript@~4.8.4: version "4.8.4" @@ -14768,11 +14805,21 @@ vitest@^0.28.3: vite-node "0.28.3" why-is-node-running "^2.2.2" +vscode-oniguruma@^1.7.0: + version "1.7.0" + resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz#439bfad8fe71abd7798338d1cd3dc53a8beea94b" + integrity sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA== + vscode-textmate@5.2.0: version "5.2.0" resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-5.2.0.tgz#01f01760a391e8222fe4f33fbccbd1ad71aed74e" integrity sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ== +vscode-textmate@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-8.0.0.tgz#2c7a3b1163ef0441097e0b5d6389cd5504b59e5d" + integrity sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg== + wait-on@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/wait-on/-/wait-on-6.0.1.tgz#16bbc4d1e4ebdd41c5b4e63a2e16dbd1f4e5601e"