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.

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

Jump to bottom

Update docusaurus monorepo to v3 (major) #125

Merged
merged 4 commits into from
Nov 6, 2023
Merged

Update docusaurus monorepo to v3 (major) #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9c6ed3
Update docusaurus monorepo to v3
renovate[bot] Nov 6, 2023
ade3ef0
deps: update required dependencies to migrate from docusuarus v2 to v3
CalvinWilkinson Nov 6, 2023
ab30134
config: make necessary changes for prism react renderer
CalvinWilkinson Nov 6, 2023
b5c6bf4
docs: refactor <summary> blocks to meet new MDX 3 requirements
CalvinWilkinson Nov 6, 2023
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
3 changes: 2 additions & 1 deletion docs/guides/guides/keyboard-input.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ field component to a value that will move the window in the direction described
This will be called later in our `OnUpdate()` method.

:::info How are time, velocity, and displacement related?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>
In our code, we're multiplying the velocity of the window's movement by the elapsed time since the last frame. This ensures
that the window moves at a consistent speed, regardless of the frame rate. Because the CPU is responsible for executing the
game logic and rendering each frame, a faster CPU can complete more operations in the same amount of time, resulting in
Expand Down
12 changes: 8 additions & 4 deletions docs/guides/guides/rendering-atlas-textures.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ Keep your needs into account as you develop your game and do not worry about per
:::

:::info Atlas Texture Scenario
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's consider a 2D space shooter game with lots of bullets and enemies. In this type of game, there may be a large
number of sprites for the player, the enemies, and the projectiles.
Expand Down Expand Up @@ -200,7 +201,8 @@ it is not required and there is no need to load the _**.png**_ and _**.json**_ f

:::info metadata format

<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's go over the JSON data that is contained in the metadata file.

Expand Down Expand Up @@ -292,7 +294,8 @@ public class Game : Window
```

:::info WHY?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Think of a [flip book](https://www.youtube.com/watch?v=Un-BdBSOGKY). If you were to flip through the pages of a flip book, you would see the animation.
The faster you flip through the pages, the faster the animation will appear. The slower you flip
Expand Down Expand Up @@ -362,7 +365,8 @@ to make something happen every 16ms to obtain that frame rate.
:::

:::info What is FPS?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

FPS stands for frames per second, which, as the name implies, is the number of frames that are rendered every second.
The game loop of a game consists of the two most important methods: `OnUpdate()` and `OnRender()`.
Expand Down
9 changes: 6 additions & 3 deletions docs/guides/guides/rendering-text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ Example: The content names _**'my-texture'**_ and _**'My-Texture'**_ are equival
:::

:::info Built In Fonts
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

Currently, four fonts come _**built-into**_ **Velaptor** and are _**Times New Roman**_.
The 4 different font types are:
Expand Down Expand Up @@ -190,7 +191,8 @@ protected override void OnDraw(FrameTime frameTime)
```

:::info What is this `IBatcher` thing?
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

As you might have guessed, this is used for batching. But that does not mean you know what "batching" is right?

Expand Down Expand Up @@ -218,7 +220,8 @@ That's it!!
:::

:::info Texture And Text Origin
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

Some game engines and frameworks use the top left corner of an object when rendering at a particular position.
**Velaptor** does not work like that. When rendering text, the position of the text is relative to the center of
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ unit test maintenance to make sure that nothing slips through the cracks.
We have achieved reliability by designing the Velaptor architecture to be loosely coupled as well as making use
of the observable pattern and dependency injection to make the code as testable as possible.

<details><summary>A quick note about unit testing</summary>
<details>
<summary>A quick note about unit testing</summary>

Unit tests are not the end-all-be-all solution for reliable bug-free software. We do not strive to have
100% code coverage for the goal of having 100% code coverage. There are areas of Velaptor that _**CANNOT**_ be tested
Expand Down
6 changes: 4 additions & 2 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const {themes} = require('prism-react-renderer');
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Velaptor',
Expand Down
24 changes: 13 additions & 11 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,21 @@
"clean": "@powershell Remove-Item .\\node_modules -Force -Recurse"
},
"dependencies": {
"@docusaurus/core": "^2.4.1",
"@docusaurus/preset-classic": "^2.4.1",
"@docusaurus/theme-mermaid": "^2.4.1",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"@docusaurus/theme-mermaid": "^3.0.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2"
"prism-react-renderer": "^2.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.4.1",
"@tsconfig/docusaurus": "^1.0.5",
"typescript": "^5.0.0"
"@docusaurus/module-type-aliases": "^3.0.0",
"@docusaurus/types": "3.0.0",
"@docusaurus/tsconfig": "^3.0.0",
"@types/react": "^18.2.29",
"typescript": "~5.2.2"
},
"browserslist": {
"production": [
Expand All @@ -43,6 +45,6 @@
]
},
"engines": {
"node": ">=16.14"
"node": ">=18.0"
}
}
3 changes: 2 additions & 1 deletion versioned_docs/version-1.0.0-preview.25/guides/guides/keyboard-input.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ field component to a value that will move the window in the direction described
This will be called later in our `OnUpdate()` method.

:::info How are time, velocity, and displacement related?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>
In our code, we're multiplying the velocity of the window's movement by the elapsed time since the last frame. This ensures
that the window moves at a consistent speed, regardless of the frame rate. Because the CPU is responsible for executing the
game logic and rendering each frame, a faster CPU can complete more operations in the same amount of time, resulting in
Expand Down
12 changes: 8 additions & 4 deletions versioned_docs/version-1.0.0-preview.25/guides/guides/rendering-atlas-textures.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ Keep your needs into account as you develop your game and do not worry about per
:::

:::info Atlas Texture Scenario
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's consider a 2D space shooter game with lots of bullets and enemies. In this type of game, there may be a large
number of sprites for the player, the enemies, and the projectiles.
Expand Down Expand Up @@ -194,7 +195,8 @@ it is not required and there is no need to load the _**.png**_ and _**.json**_ f

:::info metadata format

<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's go over the JSON data that is contained in the metadata file.

Expand Down Expand Up @@ -256,7 +258,8 @@ public class Game : Window
```

:::info WHY?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Think of a [flip book](https://www.youtube.com/watch?v=Un-BdBSOGKY). If you were to flip through the pages of a flip book, you would see the animation.
The faster you flip through the pages, the faster the animation will appear. The slower you flip
Expand Down Expand Up @@ -326,7 +329,8 @@ to make something happen every 16ms to obtain that frame rate.
:::

:::info What is FPS?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

FPS stands for frames per second, which, as the name implies, is the number of frames that are rendered every second.
The game loop of a game consists of the two most important methods: `OnUpdate()` and `OnRender()`.
Expand Down
9 changes: 6 additions & 3 deletions versioned_docs/version-1.0.0-preview.25/guides/guides/rendering-text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,8 @@ protected override void OnLoad()
}
```
:::info Built In Fonts
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

Currently, four fonts come _**built-into**_ **Velaptor** and are _**Times New Roman**_.
The 4 different font types are:
Expand Down Expand Up @@ -164,7 +165,8 @@ protected override void OnDraw(FrameTime frameTime)
```

:::info What is this `IBatcher` thing?
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

As you might have guessed, this is used for batching. But that does not mean you know what "batching" is right?

Expand Down Expand Up @@ -192,7 +194,8 @@ That's it!!
:::

:::info Texture And Text Origin
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

Some game engines and frameworks use the top left corner of an object when rendering at a particular position.
**Velaptor** does not work like that. When rendering text, the position of the text is relative to the center of
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.0.0-preview.25/guides/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ unit test maintenance to make sure that nothing slips through the cracks.
We have achieved reliability by designing the Velaptor architecture to be loosely coupled as well as making use
of the observable pattern and dependency injection to make the code as testable as possible.

<details><summary>A quick note about unit testing</summary>
<details>
<summary>A quick note about unit testing</summary>

Unit tests are not the end-all-be-all solution for reliable bug-free software. We do not strive to have
100% code coverage for the goal of having 100% code coverage. There are areas of Velaptor that _**CANNOT**_ be tested
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.0.0-preview.26/guides/guides/keyboard-input.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ field component to a value that will move the window in the direction described
This will be called later in our `OnUpdate()` method.

:::info How are time, velocity, and displacement related?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>
In our code, we're multiplying the velocity of the window's movement by the elapsed time since the last frame. This ensures
that the window moves at a consistent speed, regardless of the frame rate. Because the CPU is responsible for executing the
game logic and rendering each frame, a faster CPU can complete more operations in the same amount of time, resulting in
Expand Down
12 changes: 8 additions & 4 deletions versioned_docs/version-1.0.0-preview.26/guides/guides/rendering-atlas-textures.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ Keep your needs into account as you develop your game and do not worry about per
:::

:::info Atlas Texture Scenario
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's consider a 2D space shooter game with lots of bullets and enemies. In this type of game, there may be a large
number of sprites for the player, the enemies, and the projectiles.
Expand Down Expand Up @@ -194,7 +195,8 @@ it is not required and there is no need to load the _**.png**_ and _**.json**_ f

:::info metadata format

<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's go over the JSON data that is contained in the metadata file.

Expand Down Expand Up @@ -256,7 +258,8 @@ public class Game : Window
```

:::info WHY?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Think of a [flip book](https://www.youtube.com/watch?v=Un-BdBSOGKY). If you were to flip through the pages of a flip book, you would see the animation.
The faster you flip through the pages, the faster the animation will appear. The slower you flip
Expand Down Expand Up @@ -326,7 +329,8 @@ to make something happen every 16ms to obtain that frame rate.
:::

:::info What is FPS?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

FPS stands for frames per second, which, as the name implies, is the number of frames that are rendered every second.
The game loop of a game consists of the two most important methods: `OnUpdate()` and `OnRender()`.
Expand Down
9 changes: 6 additions & 3 deletions versioned_docs/version-1.0.0-preview.26/guides/guides/rendering-text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ Example: The content names _**'my-texture'**_ and _**'My-Texture'**_ are equival
:::

:::info Built In Fonts
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

Currently, four fonts come _**built-into**_ **Velaptor** and are _**Times New Roman**_.
The 4 different font types are:
Expand Down Expand Up @@ -186,7 +187,8 @@ protected override void OnDraw(FrameTime frameTime)
```

:::info What is this `IBatcher` thing?
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

As you might have guessed, this is used for batching. But that does not mean you know what "batching" is right?

Expand Down Expand Up @@ -214,7 +216,8 @@ That's it!!
:::

:::info Texture And Text Origin
<details><summary>Expand me to learn more!</summary>
<details>
<summary>Expand me to learn more!</summary>

Some game engines and frameworks use the top left corner of an object when rendering at a particular position.
**Velaptor** does not work like that. When rendering text, the position of the text is relative to the center of
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.0.0-preview.26/guides/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ unit test maintenance to make sure that nothing slips through the cracks.
We have achieved reliability by designing the Velaptor architecture to be loosely coupled as well as making use
of the observable pattern and dependency injection to make the code as testable as possible.

<details><summary>A quick note about unit testing</summary>
<details>
<summary>A quick note about unit testing</summary>

Unit tests are not the end-all-be-all solution for reliable bug-free software. We do not strive to have
100% code coverage for the goal of having 100% code coverage. There are areas of Velaptor that _**CANNOT**_ be tested
Expand Down
3 changes: 2 additions & 1 deletion versioned_docs/version-1.0.0-preview.27/guides/guides/keyboard-input.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ field component to a value that will move the window in the direction described
This will be called later in our `OnUpdate()` method.

:::info How are time, velocity, and displacement related?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>
In our code, we're multiplying the velocity of the window's movement by the elapsed time since the last frame. This ensures
that the window moves at a consistent speed, regardless of the frame rate. Because the CPU is responsible for executing the
game logic and rendering each frame, a faster CPU can complete more operations in the same amount of time, resulting in
Expand Down
12 changes: 8 additions & 4 deletions versioned_docs/version-1.0.0-preview.27/guides/guides/rendering-atlas-textures.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ Keep your needs into account as you develop your game and do not worry about per
:::

:::info Atlas Texture Scenario
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's consider a 2D space shooter game with lots of bullets and enemies. In this type of game, there may be a large
number of sprites for the player, the enemies, and the projectiles.
Expand Down Expand Up @@ -194,7 +195,8 @@ it is not required and there is no need to load the _**.png**_ and _**.json**_ f

:::info metadata format

<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Let's go over the JSON data that is contained in the metadata file.

Expand Down Expand Up @@ -256,7 +258,8 @@ public class Game : Window
```

:::info WHY?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

Think of a [flip book](https://www.youtube.com/watch?v=Un-BdBSOGKY). If you were to flip through the pages of a flip book, you would see the animation.
The faster you flip through the pages, the faster the animation will appear. The slower you flip
Expand Down Expand Up @@ -326,7 +329,8 @@ to make something happen every 16ms to obtain that frame rate.
:::

:::info What is FPS?
<details><summary>Expand me for more info!!</summary>
<details>
<summary>Expand me for more info!!</summary>

FPS stands for frames per second, which, as the name implies, is the number of frames that are rendered every second.
The game loop of a game consists of the two most important methods: `OnUpdate()` and `OnRender()`.
Expand Down
Loading
Loading