Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: v2 new documentation #1517

Draft
wants to merge 24 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
f0f2fc6
Updates for next branch
arendjr Nov 27, 2024
e545949
Merge branch 'main' into next
ematipico Dec 5, 2024
67b146e
feat: assist documentation (#1387)
ematipico Dec 20, 2024
53d74fd
Merge branch 'main' into next
dyc3 Feb 6, 2025
736d3d7
chore: manual sync to `bca10f5` (#1735)
dyc3 Feb 13, 2025
80d6da4
chore: use WASM main distribution (#1738)
ematipico Feb 13, 2025
ffc96c0
refactor(playground): upgrade playground to be compatible with biome …
dyc3 Feb 13, 2025
ddbae9c
feat(playground): remove import sorting tab, rename import sorting to…
dyc3 Feb 14, 2025
da08214
feat(playground): add html formatter options (#1741)
dyc3 Feb 15, 2025
43e7af8
feat(i18n): add translation of Assist for Japanese (#1745)
siketyan Feb 16, 2025
65c1753
ci: enable ja-translation workflow for next branch (#1749)
siketyan Feb 16, 2025
e19cfcd
fix(i18n): styling fix based on textlint for Japanese (#1748)
siketyan Feb 16, 2025
a08a28c
feat: Document `javascript.formatter.objectWrap` and `json.formatter.…
siketyan Feb 16, 2025
d5f3e41
feat: revamp of the linter and assist documentation (#1742)
ematipico Feb 17, 2025
e948ecf
chore: fix code quality
ematipico Feb 17, 2025
61e51d2
feat(i18n): add missing translations for Japanese (#1747)
siketyan Feb 17, 2025
afff84d
feat(i18n): Update outdated translations for Japanese (#1746)
siketyan Feb 18, 2025
599f14a
feat: add objectWrap option to the playground (#1772)
siketyan Feb 22, 2025
8550328
feat: add `objectWrap` option to the global and json formatter config…
siketyan Feb 23, 2025
574af83
Merge remote-tracking branch 'origin/main' into next
ematipico Feb 27, 2025
1bdfe37
chore: use spaces for json
ematipico Feb 27, 2025
5161aca
feat: document new options (no domains yet) (#1777)
ematipico Feb 28, 2025
4dcd136
feat(i18n): document new and updated options in Japanese (#1779)
siketyan Mar 4, 2025
cd8ce1a
Merge branch 'main' into next
siketyan Mar 4, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 6 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
pnpm-lock.yaml linguist-generated=true text=auto eol=lf
# pages and components that are auto generated
src/pages/lint/rules/**/*.md linguist-generated=true text=auto eol=lf
src/pages/lint/rules/use-*.mdx linguist-generated=true text=auto eol=lf
src/pages/lint/rules/no-*.mdx linguist-generated=true text=auto eol=lf
src/pages/lint/rules/javascript/*.mdx linguist-generated=true text=auto eol=lf
src/pages/lint/rules/css/*.mdx linguist-generated=true text=auto eol=lf
src/pages/lint/rules/graphql/*.mdx linguist-generated=true text=auto eol=lf
src/pages/lint/rules/json/*.mdx linguist-generated=true text=auto eol=lf
src/components/generated/**/*.astro linguist-generated=true text=auto eol=lf
src/pages/metadata/**/*.js linguist-generated=true text=auto eol=lf
src/pages/schemas/**/*.js linguist-generated=true text=auto eol=lf
2 changes: 1 addition & 1 deletion .github/workflows/ja-translation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Checks for Japanese documentation
on:
workflow_dispatch:
pull_request:
branches: [main]
branches: [main, next]
paths:
- "src/content/docs/ja/**"

Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ on:
branches:
- main
pull_request:
branches:
- main
env:
E2E: true
jobs:
Expand Down
3 changes: 0 additions & 3 deletions .npmrc

This file was deleted.

141 changes: 132 additions & 9 deletions astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ import { defineConfig } from "astro/config";
import rehypeSlug from "rehype-slug";
import starlightBlog from "starlight-blog";
import { searchForWorkspaceRoot } from "vite";
import { version as biomeVersion } from "./node_modules/@biomejs/wasm-web/package.json";
import { version as prettierVersion } from "./node_modules/prettier/package.json";
import { version as biomeVersion } from "./node_modules/@biomejs/wasm-web/package.json" with {
type: "json",
};
import { version as prettierVersion } from "./node_modules/prettier/package.json" with {
type: "json",
};
import { rehypeAutolink } from "./plugins/rehype-autolink";

const plugins = [
Expand Down Expand Up @@ -64,6 +68,14 @@ export default defineConfig({
title: "Biome",
defaultLocale: "root",
plugins,
expressiveCode: {
shiki: {
langAlias: {
cjs: "javascript",
grit: "txt",
},
},
},
locales: {
root: {
label: "English",
Expand Down Expand Up @@ -156,7 +168,7 @@ export default defineConfig({
link: "/guides/big-projects",
translations: {
fr: "Utiliser Biome dans de gros projets",
ja: "大きなプロジェクトでのBiomeの使用方法",
ja: "大規模プロジェクトでのBiomeの使用方法",
"zh-CN": "大型项目中使用 Biome",
"pt-BR": "Usando o Biome em projetos grandes",
uk: "Використання Biome в великих проектах",
Expand Down Expand Up @@ -323,8 +335,8 @@ export default defineConfig({
},
},
{
label: "Rules",
link: "/linter/rules",
label: "JavaScript Rules",
link: "/linter/javascript/rules",
translations: {
fr: "Règles",
ja: "ルール",
Expand All @@ -334,20 +346,128 @@ export default defineConfig({
},
},
{
label: "Rules sources",
link: "/linter/rules-sources",
label: "JavaScript Rules sources",
link: "/linter/javascript/sources",
translations: {
fr: "Sources des règles",
},
},
{
label: "CSS Rules",
link: "/linter/css/rules",
},
{
label: "CSS Rules sources",
link: "/linter/css/sources",
},
{
label: "JSON Rules",
link: "/linter/json/rules",
},
{
label: "JSON Rules sources",
link: "/linter/json/sources",
},
{
label: "GraphQL Rules",
link: "/linter/graphql/rules",
},
{
label: "GraphQL Rules sources",
link: "/linter/graphql/sources",
},
],
translations: {
fr: "Outil de linting",
uk: "Лінтер",
},
},
{
label: "Assist",
badge: "new",
items: [
{
label: "Introduction",
link: "/assist",
translations: {
ja: "イントロダクション",
"zh-CN": "介绍",
"pt-BR": "Introdução",
uk: "Вступ",
},
},
{
label: "JavaScript Actions",
link: "/assist/javascript/actions",
},
{
label: "JavaScript Actions sources",
link: "/assist/javascript/sources",
},
{
label: "CSS Actions",
link: "/assist/css/actions",
},
{
label: "CSS Actions sources",
link: "/assist/css/sources",
},
{
label: "JSON Actions",
link: "/assist/json/actions",
},
{
label: "JSON Actions sources",
link: "/assist/json/sources",
},
{
label: "GraphQL Actions",
link: "/assist/graphql/actions",
},
{
label: "GraphQL Actions sources",
link: "/assist/graphql/sources",
},
],
},
],
},
{
label: "Formatter",
items: [
{
label: "Introduction",
link: "/formatter",
translations: {
ja: "イントロダクション",
"zh-CN": "介绍",
"pt-BR": "Introdução",
},
},
{
label: "Differences with Prettier",
link: "/formatter/differences-with-prettier",
translations: {
ja: "Prettier との違い",
"zh-CN": "与 Prettier 的区别",
"pt-BR": "Diferenças em relação ao Prettier",
},
},
{
label: "Formatter Option Philosophy",
link: "/formatter/option-philosophy",
translations: {
ja: "Formatterオプションに対する考え方",
"zh-CN": "格式化配置理念",
"pt-BR": "Princípios de configuração",
},
},
],
translations: {
"zh-CN": "格式化程序",
"pt-BR": "Formatador",
},
},
{
label: "Reference",
translations: {
Expand All @@ -365,14 +485,17 @@ export default defineConfig({
{
label: "Diagnostics",
link: "/reference/diagnostics",
badge: "new",
translations: {
ja: "診断",
},
},
{
label: "Environment variables",
link: "/reference/environment-variables",
translations: {
fr: "Variables d’environnement",
uk: "Змінні середовища",
ja: "環境変数",
},
},
{
Expand All @@ -381,6 +504,7 @@ export default defineConfig({
translations: {
fr: "Outils de reporting",
uk: "Звіти",
ja: "リポータ",
},
},
{
Expand All @@ -407,7 +531,6 @@ export default defineConfig({
{
label: "Zed extension",
link: "/reference/zed",
badge: "new",
translations: {
fr: "Extension pour Zed",
ja: "Zed拡張機能",
Expand Down
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
"files": {
"ignore": ["rules.json.js", "schema.json.js"]
},
Expand Down
Loading
Loading