3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-12 15:52:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: update examples for Docusaurus 3.8 (#11202)

Browse source
This commit is contained in:
Sébastien Lorber 2025-05-27 12:42:26 +02:00 • committed by GitHub
parent b126e643d1
commit 7e87ea320c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 3183 additions and 3709 deletions
Download patch file Download diff file Expand all files Collapse all files

18
examples/classic-typescript/README.md generated
View file

@ -2,40 +2,40 @@
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation ## Installation
```bash ```bash
$ yarn yarn
``` ```
### Local Development ## Local Development
```bash ```bash
$ yarn start yarn start
``` ```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build ## Build
```bash ```bash
$ yarn build yarn build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment ## Deployment
Using SSH: Using SSH:
```bash ```bash
$ USE_SSH=true yarn deploy USE_SSH=true yarn deploy
``` ```
Not using SSH: Not using SSH:
```bash ```bash
$ GIT_USER=<Your GitHub username> yarn deploy GIT_USER=<Your GitHub username> yarn deploy
``` ```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

6
examples/classic-typescript/blog/authors.yml generated
View file

@ -1,12 +1,14 @@
yangshun: yangshun:
name: Yangshun Tay name: Yangshun Tay
title: Front End Engineer @ Facebook title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
url: https://github.com/yangshun url: https://linkedin.com/in/yangshun
image_url: https://github.com/yangshun.png image_url: https://github.com/yangshun.png
page: true page: true
socials: socials:
x: yangshunz x: yangshunz
linkedin: yangshun
github: yangshun github: yangshun
newsletter: https://www.greatfrontend.com
slorber: slorber:
name: Sébastien Lorber name: Sébastien Lorber

5
examples/classic-typescript/docusaurus.config.ts generated
View file

@ -9,6 +9,11 @@ const config: Config = {
tagline: 'Dinosaurs are cool', tagline: 'Dinosaurs are cool',
favicon: 'img/favicon.ico', favicon: 'img/favicon.ico',
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
future: {
v4: true, // Improve compatibility with the upcoming Docusaurus v4
},
// Set the production url of your site here // Set the production url of your site here
url: 'https://your-docusaurus-site.example.com', url: 'https://your-docusaurus-site.example.com',
// Set the /<baseUrl>/ pathname under which your site is served // Set the /<baseUrl>/ pathname under which your site is served

10
examples/classic-typescript/package.json generated
View file

@ -16,8 +16,8 @@
"dev": "docusaurus start" "dev": "docusaurus start"
}, },
"dependencies": { "dependencies": {
"@docusaurus/core": "3.7.0", "@docusaurus/core": "3.8.0",
"@docusaurus/preset-classic": "3.7.0", "@docusaurus/preset-classic": "3.8.0",
"@mdx-js/react": "^3.0.0", "@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0", "clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0", "prism-react-renderer": "^2.3.0",
@ -25,9 +25,9 @@
"react-dom": "^19.0.0" "react-dom": "^19.0.0"
}, },
"devDependencies": { "devDependencies": {
"@docusaurus/module-type-aliases": "3.7.0", "@docusaurus/module-type-aliases": "3.8.0",
"@docusaurus/tsconfig": "3.7.0", "@docusaurus/tsconfig": "3.8.0",
"@docusaurus/types": "3.7.0", "@docusaurus/types": "3.8.0",
"typescript": "~5.6.2" "typescript": "~5.6.2"
}, },
"browserslist": { "browserslist": {

3412
examples/classic-typescript/yarn.lock generated
View file

File diff suppressed because it is too large Load diff

18
examples/classic/README.md generated
View file

@ -2,40 +2,40 @@
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation ## Installation
```bash ```bash
$ yarn yarn
``` ```
### Local Development ## Local Development
```bash ```bash
$ yarn start yarn start
``` ```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build ## Build
```bash ```bash
$ yarn build yarn build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment ## Deployment
Using SSH: Using SSH:
```bash ```bash
$ USE_SSH=true yarn deploy USE_SSH=true yarn deploy
``` ```
Not using SSH: Not using SSH:
```bash ```bash
$ GIT_USER=<Your GitHub username> yarn deploy GIT_USER=<Your GitHub username> yarn deploy
``` ```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

6
examples/classic/blog/authors.yml generated
View file

@ -1,12 +1,14 @@
yangshun: yangshun:
name: Yangshun Tay name: Yangshun Tay
title: Front End Engineer @ Facebook title: Ex-Meta Staff Engineer, Co-founder GreatFrontEnd
url: https://github.com/yangshun url: https://linkedin.com/in/yangshun
image_url: https://github.com/yangshun.png image_url: https://github.com/yangshun.png
page: true page: true
socials: socials:
x: yangshunz x: yangshunz
linkedin: yangshun
github: yangshun github: yangshun
newsletter: https://www.greatfrontend.com
slorber: slorber:
name: Sébastien Lorber name: Sébastien Lorber

5
examples/classic/docusaurus.config.js generated
View file

@ -14,6 +14,11 @@ const config = {
tagline: 'Dinosaurs are cool', tagline: 'Dinosaurs are cool',
favicon: 'img/favicon.ico', favicon: 'img/favicon.ico',
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
future: {
v4: true, // Improve compatibility with the upcoming Docusaurus v4
},
// Set the production url of your site here // Set the production url of your site here
url: 'https://your-docusaurus-site.example.com', url: 'https://your-docusaurus-site.example.com',
// Set the /<baseUrl>/ pathname under which your site is served // Set the /<baseUrl>/ pathname under which your site is served

8
examples/classic/package.json generated
View file

@ -15,8 +15,8 @@
"dev": "docusaurus start" "dev": "docusaurus start"
}, },
"dependencies": { "dependencies": {
"@docusaurus/core": "3.7.0", "@docusaurus/core": "3.8.0",
"@docusaurus/preset-classic": "3.7.0", "@docusaurus/preset-classic": "3.8.0",
"@mdx-js/react": "^3.0.0", "@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0", "clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0", "prism-react-renderer": "^2.3.0",
@ -24,8 +24,8 @@
"react-dom": "^19.0.0" "react-dom": "^19.0.0"
}, },
"devDependencies": { "devDependencies": {
"@docusaurus/module-type-aliases": "3.7.0", "@docusaurus/module-type-aliases": "3.8.0",
"@docusaurus/types": "3.7.0" "@docusaurus/types": "3.8.0"
}, },
"browserslist": { "browserslist": {
"production": [ "production": [

3404
examples/classic/yarn.lock generated
View file

File diff suppressed because it is too large Load diff