feat(docs): Upgrade to docusaurus v3 (#30)

5e-bits · Apr 3, 2024 · ee487ea · ee487ea
1 parent e637902
commit ee487ea
Show file tree

Hide file tree

Showing 28 changed files with 1,132 additions and 2,150 deletions.
diff --git a/.gitignore b/.gitignore
@@ -222,4 +222,3 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/node,windows,macos
-
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 

diff --git a/babel.config.js b/babel.config.js
@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
 };
diff --git a/docs/faq.md b/docs/faq.md
@@ -18,4 +18,4 @@ Yes it can! You can also host the data yourself if you don't want to use the API
 
 ### Can I publish is on `<insert platform>`? Is this free use?
 
-Yes, you can. The API itself is under the [MIT license](https://opensource.org/licenses/MIT), and the underlying data accessible via the API is supported under the SRD and OGL.
+Yes, you can. The API itself is under the [MIT license](https://opensource.org/licenses/MIT), and the underlying data accessible via the API is supported under the SRD and OGL.
diff --git a/docs/graphql.md b/docs/graphql.md
@@ -20,4 +20,4 @@ query {
     }
   }
 }
-```
+```
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -10,15 +10,15 @@ sidebar_position: 1
 
 ### :wave: Welcome
 
-Welcome to the D&D 5e SRD API, the Dungeons & Dragons 5th Edition API! 
+Welcome to the D&D 5e SRD API, the Dungeons & Dragons 5th Edition API!
 
-This documentation should help you familiarize yourself with the resources available and how to consume them with HTTP requests. Read through the [Tutorial](/docs/tutorials/) getting started section before you dive in. 
+This documentation should help you familiarize yourself with the resources available and how to consume them with HTTP requests. Read through the [Tutorial](/docs/tutorials/) getting started section before you dive in.
 
 Most of your problems should be solved just by reading through it.
 
 ### :lock: Authentication
 
-This is a completely open API. **No authentication is required to query and get data**. This also means that we've limited what you can do to just `GET`-ing the data. 
+This is a completely open API. **No authentication is required to query and get data**. This also means that we've limited what you can do to just `GET`-ing the data.
 
 If you find a mistake in the data, feel free to [message us](https://discord.gg/TQuYTv7)!
 

diff --git a/docs/reference/status-page.md b/docs/reference/status-page.md
@@ -3,4 +3,3 @@
 The status page for the API can be found [here](https://5e-bits.github.io/dnd-uptime/).
 
 ![Status Page](/img/status-page.png)
-
diff --git a/docs/tutorials/advanced/monster-search-with-javascript.mdx b/docs/tutorials/advanced/monster-search-with-javascript.mdx
@@ -178,5 +178,4 @@ function searchMonster(monsterName) {
 
 ## Conclusion
 
-Congratulations! You've successfully built an interactive monster search web application using JavaScript, HTML, and CSS. Users can now search for D&D 5e monsters and view their details. 
-
+Congratulations! You've successfully built an interactive monster search web application using JavaScript, HTML, and CSS. Users can now search for D&D 5e monsters and view their details.
diff --git a/docs/tutorials/basic/discover-dnd-races-with-shell-scripting.mdx b/docs/tutorials/basic/discover-dnd-races-with-shell-scripting.mdx
@@ -3,8 +3,8 @@ import LearningObjectives from '@site/src/components/LearningObjectives';
 # Discover D&D Races with Shell Scripting
 
 <LearningObjectives objectives={[
-    "Learn to use cURL", 
-    "Learn to write a simple Bash script", 
+    "Learn to use cURL",
+    "Learn to write a simple Bash script",
     "Learn to make a script interactive"
 ]}/>
 
@@ -100,4 +100,3 @@ Enter the name of a D&D race: dwarf
 ## Celebrate Your Coding Victory!
 
 Congratulations, young adventurers! You've crafted your very own D&D Race Search Tool using Bash scripting. You can now explore different races and learn about their unique abilities, traits, and more. Your journey has just begun, and there's so much more to discover in the realm of coding and Dungeons & Dragons. May your code be bug-free and your rolls be critical hits! 🎉🏰🧝‍♂️
-
diff --git a/docs/tutorials/beginner/graphql.mdx b/docs/tutorials/beginner/graphql.mdx
@@ -39,7 +39,7 @@ Let's start by getting a list of all the monsters in the database. To do this, w
 ```graphql
 query Monsters {
   monsters {
-    
+
   }
 }
 ```
@@ -59,7 +59,7 @@ query Monsters {
     name
     index
     armor_class {
-      
+
     }
   }
 }

diff --git a/docs/tutorials/index.mdx b/docs/tutorials/index.mdx
@@ -24,4 +24,3 @@ Basic tutorials are designed to help you get started with the API. They are inte
 Advanced tutorials are designed to help you build more complex applications with the API. They are intended for developers who are comfortable with programming and want to build more advanced applications.
 
 <TutorialsList category="advanced" />
-
diff --git a/docusaurus.config.js b/docusaurus.config.js
Original file line number	Diff line number	Diff line change
Expand Up		@@ -222,4 +222,3 @@ $RECYCLE.BIN/
		*.lnk

		# End of https://www.toptal.com/developers/gitignore/api/node,windows,macos
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,4 +18,4 @@ Yes it can! You can also host the data yourself if you don't want to use the API

		### Can I publish is on `<insert platform>`? Is this free use?

		Yes, you can. The API itself is under the [MIT license](https://opensource.org/licenses/MIT), and the underlying data accessible via the API is supported under the SRD and OGL.
		Yes, you can. The API itself is under the [MIT license](https://opensource.org/licenses/MIT), and the underlying data accessible via the API is supported under the SRD and OGL.
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,4 +20,4 @@ query { @@
         }
       }
     }
-    ```
+    ```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,4 +3,3 @@
		The status page for the API can be found [here](https://5e-bits.github.io/dnd-uptime/).

		![Status Page](/img/status-page.png)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -178,5 +178,4 @@ function searchMonster(monsterName) {

		## Conclusion

		Congratulations! You've successfully built an interactive monster search web application using JavaScript, HTML, and CSS. Users can now search for D&D 5e monsters and view their details.

		Congratulations! You've successfully built an interactive monster search web application using JavaScript, HTML, and CSS. Users can now search for D&D 5e monsters and view their details.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,3 @@ Basic tutorials are designed to help you get started with the API. They are inte
		Advanced tutorials are designed to help you build more complex applications with the API. They are intended for developers who are comfortable with programming and want to build more advanced applications.

		<TutorialsList category="advanced" />