farm-fe / farm-fe.github.io

Documentation of Farm

Farm docs

Docs site of Farm.

Install dependencies:

pnpm i

Development locally:

npm start

Merge the changes to main will automatically publish to github pages.

farm-fe.github.io's Issues

Invalid template in some of the commands to create new Farm projects on the Quick Start page

Hi! 👋

When trying to create a new Farm project from one of the npm commands (npm 7+) available on the Quick Start page of the documentation, I got this error:

npm create farm@latest my-vue-app -- --template vue

 ⚡ Welcome To Farm !



 error: failed to parse 'vue': vue is not a valid template. Valid templates are [vanilla, react, vue3, vue2, lit, svelte, solid, preact, nestjs, tauri, tauri-React - (https://react.dev/), tauri-Vue3 - (https://vuejs.org/), tauri-Vanilla, tauri-Svelte - (https://svelte.dev/), tauri-Solid - (https://solidjs.com/), tauri-Preact - (https://preactjs.com/), electron, electron-React - (https://react.dev/), electron-Vue3 - (https://vuejs.org/), electron-Vanilla, electron-Svelte - (https://svelte.dev/), electron-Solid - (https://solidjs.com/), electron-Preact - (https://preactjs.com/)]

npm ERR! code 1
npm ERR! path /Users/joao.palmeiro/Documents
npm ERR! command failed
npm ERR! command sh -c create-farm my-vue-app --template vue

npm ERR! A complete log of this run can be found in: /Users/joao.palmeiro/.npm/_logs/2024-06-22T08_02_31_878Z-debug-0.log

I think it's because the vue template doesn't exist (the Vue-related templates are the vue3 and vue2 templates). Furthermore, these commands are not consistent with each other as Yarn's, for example, uses the react template. So, I think it would be useful to standardize the template chosen in these commands for react or vue3 (and the project folder name if necessary).

Let me know your thoughts and if I can open a PR!

Thanks! 😄

Docs for new plugin hook

add doc for process_generated_resources and handle_entry_resource

Remove CSS that prohibits text selection

The current page is disabled by CSS and cannot select text. When I tried to copy some configuration files, I encountered obstacles and had to use the copy function of the code block to make the changes again.
This undoubtedly increases the workload of usage.

add publicDir docs for static assets

Wrong HMR configuration

https://www.farmfe.org/docs/config/dev-server#hmr

Add docs for handling global persistent cache key

Update minify docs

• And introduce how to debug production issues
• add description for minify.moduleDecl
• add description for bundle size optimization

the social icons at the bottom don't work

The social icons at the bottom are not wrapped in a link <a />

Could somebody add urls for twitter/x and discord?

Also, is there a svg for X (formerly twitter)?

Add docs for ensuring strong consistency

Remove the Glowing strips in Documentation

---

these diagonal strips make the documentation harder to read.
Even though its a nice touch for the site, it distracts users from reading the docs. Especially when scrolling.

Display the error subtitle in the chapter titled "dev-server" related to project configuration.

detail at https://farm-fe.github.io/docs/config/dev-server/

Replace Docusaurus OG Image

It seems that farm's documentation site still points to Docusaurus OG Image. I would fix this sooner rather than later considering the v1 release hype.

Add docs for top level await

Add docs for handling external modules

Add trouble shooting docs

including the css alpha opecity issue.

Update Rust Plugin Usage Doc

since 1.3.0, rust plugins can be used the same as js plugins:

import farmPlugin from 'farm-plugin-xxx'; // import farm rust plugin

export default {
  plugins: [
    farmPlugin() // use rust plugin the same as js plugin
   ],
}