Merge branch 'refactor/node' into refactor/preview-server

farm-fe · Sep 27, 2024 · 5cfd619 · 5cfd619
2 parents e5c283f + df5dfa8
commit 5cfd619
Show file tree

Hide file tree

Showing 15 changed files with 661 additions and 169 deletions.
diff --git a/cspell.json b/cspell.json
@@ -6,29 +6,46 @@
   "language": "en",
   // words - list of words to be always considered correct
   "words": [
+    "3Csvg",
     "aarch",
+    "Aavci",
+    "Aceternity",
+    "ACVHU",
     "addtional",
     "Alexey",
+    "Andale",
     "androideabi",
     "antd",
     "Antdv",
     "apng",
     "applescript",
+    "AQDBI",
     "Architecure",
     "armv",
     "arraify",
+    "assuptions",
     "Avenir",
     "Bartosz",
     "Basepath",
+    "begining",
+    "bento",
+    "Bento",
     "bindgen",
+    "Bitstream",
+    "Bluch",
     "bpos",
+    "breo",
     "brightwu",
     "Brooooooklyn",
     "bufferutil",
+    "buidling",
     "Bytedance",
     "bytepos",
+    "Cace",
     "cacheable",
+    "callqh",
     "canonicalize",
+    "Cfudsi",
     "changset",
     "chpos",
     "clippy",
@@ -41,58 +58,81 @@
     "compat",
     "concurrentify",
     "Consolas",
-    "Convertion",
     "consts",
     "Convertion",
     "cpus",
     "csspart",
+    "cssvars",
     "ctxt",
+    "Cuph",
     "dashmap",
     "dedupe",
     "deepmerge",
+    "demostration",
     "Denysov",
     "Deoptimization",
     "Deque",
+    "derectly",
     "deserializers",
     "dialoguer",
     "DIMRESET",
+    "docsearch",
+    "doctag",
+    "documate",
+    "drei",
     "dylib",
     "eabi",
     "eframe",
     "egui",
     "elems",
     "embeded",
     "envinfo",
+    "Erkelost",
     "esbuild",
+    "Esdx",
     "execa",
+    "exlude",
     "fargs",
     "farmfe",
+    "farmup",
+    "Farmup",
+    "feio",
     "fibo",
     "flac",
+    "flexbox",
     "fnames",
     "Fock",
     "funs",
+    "Gamage",
     "globset",
+    "GLTF",
+    "Glvyg",
     "gnueabihf",
     "guolao",
     "hashbrown",
     "hasher",
     "Hensel",
+    "Himesh",
     "HMRPing",
     "icns",
     "idents",
     "IHDR",
     "iife",
+    "Iljwt",
     "importee",
     "Inctive",
     "indicatif",
+    "Infima",
     "instanceof",
     "Instantiator",
+    "JDEL",
     "jfif",
     "JIDA",
     "jquery",
     "jridgewell",
     "jsnext",
+    "Jsxhmf",
+    "Jtjc",
     "kolorist",
     "Kostiantyn",
     "libfarmfe",
@@ -101,35 +141,51 @@
     "linechpos",
     "loglevel",
     "lukastaegert",
+    "maked",
     "mapref",
     "Margus",
     "mdsvex",
     "Menlo",
     "Mergeable",
+    "metastring",
     "mgfe",
     "middlewares",
     "minifier",
+    "moduletypes",
     "msvc",
     "multibyte",
     "musleabihf",
     "nanos",
     "nanospinner",
     "napi",
     "NAPI",
+    "neccessary",
+    "NITH",
     "nodebuffer",
     "Nonoctal",
+    "noopener",
     "nord",
+    "noreferrer",
     "normpath",
     "npmlog",
+    "nums",
+    "Nybxx",
+    "Oaky",
+    "oblador",
+    "ohter",
     "onwarn",
     "opentelemetry",
     "osascript",
+    "Oudd",
     "outro",
+    "Oyzy",
     "pageerror",
     "pargs",
     "pathdiff",
     "peekable",
     "petgraph",
+    "pffn",
+    "phvjb",
     "pico",
     "picomatch",
     "Pinia",
@@ -140,44 +196,68 @@
     "preact",
     "prefixer",
     "primevue",
+    "procee",
     "proto",
     "protobuf",
     "protoc",
+    "Ptktl",
+    "PUFY",
+    "pulgin",
+    "PVPW",
+    "pxtorem",
     "quasis",
     "querify",
     "querystring",
     "Raspopov",
+    "raxjs",
+    "Rcfchj",
+    "Rdjg",
     "reduckted",
     "replacen",
     "repr",
+    "Reshammiya",
     "rfind",
+    "RFVLYs",
     "riscv",
     "rkyv",
+    "Rolup",
     "rootpath",
+    "rsbuild",
     "rsdoctor",
     "Rspack",
     "rsplit",
+    "rspress",
+    "Rucdk",
     "Rustup",
     "sabi",
     "safelisted",
+    "Salman",
+    "serde",
     "shiki",
     "shulan",
     "shulandmimi",
     "Sider",
+    "siderbar",
     "sirv",
     "Skeen",
     "srcset",
     "struct",
+    "structs",
     "styl",
     "stylesheet",
     "Stylesheet",
+    "sublist",
     "svgr",
+    "svgs",
+    "SXNQ",
+    "tabler",
     "tailwindcss",
     "Tauri",
     "teidesu",
     "Tencent",
     "thiserror",
     "threadsafe",
+    "tnum",
     "topo",
     "toposort",
     "treeshake",
@@ -186,23 +266,39 @@
     "tsup",
     "Turbopack",
     "Typecheck",
+    "typedotenv",
     "typeofs",
+    "Ujanq",
+    "unioned",
     "unocss",
     "unplugin",
     "unref",
     "unsize",
     "unwatch",
+    "UOUI",
     "upcasting",
+    "usize",
+    "VDSVA",
     "Verinov",
+    "Vgud",
+    "virutal",
     "vite",
+    "vitesse",
+    "Vklun",
     "walkdir",
     "wasi",
     "wasix",
     "wasmer",
+    "Webscoker",
     "wechat",
     "Wojtkowiak",
     "xlink",
-    "Yuxi"
+    "Yhci",
+    "Yuxi",
+    "ZERs",
+    "Zjwg",
+    "Zwram",
+    "zzse"
   ],
   "ignorePaths": [
     "pnpm-lock.yaml",

diff --git a/docs/docs/quick-start.mdx b/docs/docs/quick-start.mdx
@@ -10,6 +10,21 @@ import { PackageManagerTabs } from "@site/src/theme/PackageManagerTabs";
 :::note
 Farm needs **Node 16.18.0 and above**.
 :::
+:::important
+Farm needs **Node 16.18.0 and above**.
+:::
+:::info
+Farm needs **Node 16.18.0 and above**.
+:::
+:::tip
+Farm needs **Node 16.18.0 and above**.
+:::
+:::warning
+Farm needs **Node 16.18.0 and above**.
+:::
+:::danger
+Farm needs **Node 16.18.0 and above**.
+:::
 
 ## Online experience
 

diff --git a/docs/docs/tutorials/3-build.md b/docs/docs/tutorials/3-build.md
@@ -22,7 +22,7 @@ Add build script in `package.json`:
 ```
 Then execute `npm run build`, the built resources will be emitted to `build` dir:
 
-```text
+```text title="Project Build Resource Structure"
 build
 ├─ favicon.ico
 ├─ index.html
@@ -43,7 +43,7 @@ If you want to custom the path that the resources emitted to, you can use:
 * [`output.filename`](/docs/config/compilation-options#outputfilename)
 * [`output.assetsFilename`](/docs/config/compilation-options#outputassetsfilename)
 
-```ts
+```ts title="farm.config.ts"
 import defineConfig from '@farmfe/core';
 
 export default defineConfig({
@@ -123,4 +123,4 @@ For details about tree shake and minify, see:
 Refer to [Partial Bundling](/docs/advanced/partial-bundling) for details.
 :::
 
-Farm enabled best practice of bundling already, make sure you really need to configure bundles manually. See [Partial Bundling](/docs/advanced/partial-bundling) for details.
+Farm enabled best practice of bundling already, make sure you really need to configure bundles manually. See [Partial Bundling](/docs/advanced/partial-bundling) for details.
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -1,4 +1,5 @@
 import { themes as prismThemes } from "prism-react-renderer";
+import remarkGfm from "remark-gfm";
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -35,14 +36,21 @@ const config = {
   },
 
   presets: [
+    // [
+    //   'docusaurus-preset-shiki-twoslash',
+    //   {
+    //     themes: ['light-plus', 'dark-plus'],
+    //   },
+    // ],
     [
-      "classic",
+      "@docusaurus/preset-classic",
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
           sidebarPath: require.resolve("./sidebars.js"),
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
+          // remarkPlugins: [remarkGfm],
           editUrl: "https://github.com/farm-fe/farm-fe.github.io/tree/main/",
           lastVersion: "current",
           versions: {

diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/features/css.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/features/css.md
@@ -177,4 +177,4 @@ div {
 输出
 ```css
 div{display:-ms-flexbox;display:flex}
-```
+```
diff --git a/docs/package.json b/docs/package.json
@@ -41,6 +41,7 @@
     "autoprefixer": "^10.4.14",
     "class-variance-authority": "^0.7.0",
     "docusaurus-plugin-sass": "0.2.5",
+    "docusaurus-preset-shiki-twoslash": "^1.1.41",
     "leva": "^0.9.35",
     "lucide-react": "^0.394.0",
     "markdown-it": "^14.1.0",
@@ -53,6 +54,7 @@
     "react-icons": "^5.3.0",
     "react-intersection-observer": "^9.5.1",
     "react-use-measure": "^2.1.1",
+    "remark-gfm": "^4.0.0",
     "sass": "^1.63.6",
     "three": "0.168.0"
   },