mirror of
https://github.com/jakejarvis/sofa.git
synced 2026-08-29 02:45:39 -04:00
Migrate the entire monorepo from Biome 2.4.7 to oxlint 1.56.0 (linter) and oxfmt 0.41.0 (formatter) for faster lint/format and broader rule coverage. - Add `.oxlintrc.json` with React, TypeScript, unicorn, import plugins and correctness/suspicious categories - Add `.oxfmtrc.json` with 2-space indent, import sorting, and Tailwind class sorting (all 30+ custom className attributes migrated) - Add `docs/.oxlintrc.json` and `docs/.oxfmtrc.json` with Next.js plugin - Update all 12 workspace package.json scripts: `oxlint`, `oxfmt`, `oxfmt --check` - Add `format:check` turbo task and CI step - Update VS Code settings/extensions to use `oxc.oxc-vscode` - Update CI path triggers from `biome.json` to new config files - Remove all `biome-ignore` comments and fix shadowed variables - Delete `biome.json` and `docs/biome.json` - Reformat entire codebase with oxfmt Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
# sofa-docs
|
|
|
|
This is a Next.js application generated with [Create Fumadocs](https://github.com/fuma-nama/fumadocs).
|
|
|
|
Run development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
# or
|
|
pnpm dev
|
|
# or
|
|
yarn dev
|
|
```
|
|
|
|
Open http://localhost:3000 with your browser to see the result.
|
|
|
|
## Explore
|
|
|
|
In the project, you can see:
|
|
|
|
- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
|
|
- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.
|
|
|
|
| Route | Description |
|
|
| ------------------------- | ------------------------------------------------------ |
|
|
| `app/(home)` | The route group for your landing page and other pages. |
|
|
| `app/docs` | The documentation layout and pages. |
|
|
| `app/api/search/route.ts` | The Route Handler for search. |
|
|
|
|
### Fumadocs MDX
|
|
|
|
A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
|
|
|
|
Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
|
|
|
|
## Learn More
|
|
|
|
To learn more about Next.js and Fumadocs, 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.
|
|
- [Fumadocs](https://fumadocs.dev) - learn about Fumadocs
|