Skip to content

docs(llms.txt): upgrade to [email protected] and add llms.txt #954

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 24, 2025
Merged

docs(llms.txt): upgrade to [email protected] and add llms.txt #954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81d9dfe
chore(deps): upgrade to [email protected]
SoonIter Apr 24, 2025
ab84b41
chore: add cspell
SoonIter Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 72 additions & 54 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions scripts/dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ jsxs
koppers
lightningcss
liyincode
llms
longpaths
manypkg
mattcompiles
Expand Down
8 changes: 4 additions & 4 deletions website/docs/en/guide/basic/output-format.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ESM from '../start/components/ESM.mdx';
import CJS from '../start/components/CJS.mdx';
import UMD from '../start/components/UMD.mdx';
import MF from '../start/components/MF.mdx';
import ESM from '../../shared/components/ESM.mdx';
import CJS from '../../shared/components/CJS.mdx';
import UMD from '../../shared/components/UMD.mdx';
import MF from '../../shared/components/MF.mdx';

# Output format

Expand Down
8 changes: 4 additions & 4 deletions website/docs/en/guide/start/glossary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ESM from './components/ESM.mdx';
import CJS from './components/CJS.mdx';
import UMD from './components/UMD.mdx';
import MF from './components/MF.mdx';
import ESM from '../../shared/components/ESM.mdx';
import CJS from '../../shared/components/CJS.mdx';
import UMD from '../../shared/components/UMD.mdx';
import MF from '../../shared/components/MF.mdx';

# Glossary

Expand Down
0 ...te/docs/en/guide/start/components/CJS.mdx → website/docs/en/shared/components/CJS.mdx
View file
Open in desktop
File renamed without changes.
0 ...te/docs/en/guide/start/components/ESM.mdx → website/docs/en/shared/components/ESM.mdx
View file
Open in desktop
File renamed without changes.
0 ...ite/docs/en/guide/start/components/MF.mdx → website/docs/en/shared/components/MF.mdx
View file
Open in desktop
File renamed without changes.
0 ...te/docs/en/guide/start/components/UMD.mdx → website/docs/en/shared/components/UMD.mdx
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions website/docs/zh/guide/basic/output-format.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ESM from '../start/components/ESM.mdx';
import CJS from '../start/components/CJS.mdx';
import UMD from '../start/components/UMD.mdx';
import MF from '../start/components/MF.mdx';
import ESM from '../../shared/components/ESM.mdx';
import CJS from '../../shared/components/CJS.mdx';
import UMD from '../../shared/components/UMD.mdx';
import MF from '../../shared/components/MF.mdx';

# 产物输出格式

Expand Down
8 changes: 4 additions & 4 deletions website/docs/zh/guide/start/glossary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ESM from './components/ESM.mdx';
import CJS from './components/CJS.mdx';
import UMD from './components/UMD.mdx';
import MF from './components/MF.mdx';
import ESM from '../../shared/components/ESM.mdx';
import CJS from '../../shared/components/CJS.mdx';
import UMD from '../../shared/components/UMD.mdx';
import MF from '../../shared/components/MF.mdx';

# 名词解释

Expand Down
0 ...te/docs/zh/guide/start/components/CJS.mdx → website/docs/zh/shared/components/CJS.mdx
View file
Open in desktop
File renamed without changes.
0 ...te/docs/zh/guide/start/components/ESM.mdx → website/docs/zh/shared/components/ESM.mdx
View file
Open in desktop
File renamed without changes.
0 ...ite/docs/zh/guide/start/components/MF.mdx → website/docs/zh/shared/components/MF.mdx
View file
Open in desktop
File renamed without changes.
0 ...te/docs/zh/guide/start/components/UMD.mdx → website/docs/zh/shared/components/UMD.mdx
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@
"@rsbuild/core": "1.3.9",
"@rsbuild/plugin-sass": "^1.3.1",
"@rslib/tsconfig": "workspace:*",
"@rspress/plugin-llms": "2.0.0-beta.2",
"@rstack-dev/doc-ui": "1.8.0",
"@types/node": "^22.8.1",
"@types/react": "^19.1.2",
"@types/react-dom": "^19.1.2",
"react": "^19.1.0",
"react-dom": "^19.1.0",
"rsbuild-plugin-google-analytics": "1.0.3",
"rspress": "^2.0.0-beta.0",
"rspress": "2.0.0-beta.2",
"rspress-plugin-font-open-sans": "1.0.0"
}
}
6 changes: 4 additions & 2 deletions website/rspress.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
import path from 'node:path';
import { pluginSass } from '@rsbuild/plugin-sass';
import { pluginLlms } from '@rspress/plugin-llms';
import { pluginGoogleAnalytics } from 'rsbuild-plugin-google-analytics';
import { pluginFontOpenSans } from 'rspress-plugin-font-open-sans';
import { defineConfig } from 'rspress/config';

export default defineConfig({
plugins: [pluginFontOpenSans()],
plugins: [pluginFontOpenSans(), pluginLlms()],
root: path.join(__dirname, 'docs'),
lang: 'en',
base: '/',
title: 'Rslib',
description: 'Rsbuild-based library development tool',
icon: 'https://assets.rspack.dev/rslib/rslib-logo-192x192.png',
logo: 'https://assets.rspack.dev/rslib/rslib-logo-192x192.png',
logoText: 'Rslib',
Expand All @@ -22,7 +24,7 @@ export default defineConfig({
route: {
cleanUrls: true,
// exclude document fragments from routes
exclude: ['**/zh/shared/**', '**/en/shared/**', './theme'],
exclude: ['**/zh/shared/**', '**/en/shared/**'],
},
themeConfig: {
socialLinks: [
Expand Down
Loading