From ddd5cd9c983a674e61a4f8e92a4448faff6e6196 Mon Sep 17 00:00:00 2001
From: Arianrhod Sandlot
Date: Sun, 5 Nov 2023 22:36:54 +0800
Subject: [PATCH] docs: update docs
---
docs/astro.config.ts | 1 -
docs/src/content/docs/guides/related.md | 2 +-
docs/src/content/docs/index.mdx | 10 +++-------
readme.md | 4 ++--
4 files changed, 6 insertions(+), 11 deletions(-)
diff --git a/docs/astro.config.ts b/docs/astro.config.ts
index da785b5..85aa8fe 100644
--- a/docs/astro.config.ts
+++ b/docs/astro.config.ts
@@ -14,7 +14,6 @@ export default defineConfig({
},
social: {
github: 'https://github.com/arianrhodsandlot/nostalgist',
- twitter: 'https://twitter.com/arianrhodsand',
},
customCss: ['./src/styles/custom.css'],
editLink: {
diff --git a/docs/src/content/docs/guides/related.md b/docs/src/content/docs/guides/related.md
index 7448259..d023d3c 100644
--- a/docs/src/content/docs/guides/related.md
+++ b/docs/src/content/docs/guides/related.md
@@ -16,7 +16,7 @@ title: Related
+ [jsDelivr](https://www.jsdelivr.com/)
## Showcases
-+ [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly)
++ [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly)
A web app with which you can build a custom retro gaming library inside your browser.
Game states can be synced with cloud storage services like OneDrive/Google Drive/Dropbox
diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx
index e4abdac..72a2faf 100644
--- a/docs/src/content/docs/index.mdx
+++ b/docs/src/content/docs/index.mdx
@@ -46,9 +46,9 @@ Nostalgist.js is a JavaScript library that allows you to run emulators of retro
API reference
----
-
----
+:::tip
+⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source projects [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly).
+:::
## A Quick Glance
Nostalgist.js is a JavaScript library that allows you to run emulators of retro consoles like NES and Sega Genesis, within web browsers.
@@ -170,10 +170,6 @@ The purpose of Nostalgist.js is to simplify the process of launching an emulator
href="/guides/getting-started"
/>
-:::tip
-⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source projects [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly).
-:::
-
:::caution[Caveat]
Nostalgist.js **DOES NOT** provide any pirated content, like copyrighted ROM files or BIOS files. And it **DOES NOT** encourage that.
:::
diff --git a/readme.md b/readme.md
index 1857cb0..c5a018b 100644
--- a/readme.md
+++ b/readme.md
@@ -18,7 +18,7 @@
Nostalgist.js is a JavaScript library that allows you to run emulators of retro consoles, like NES and Sega Genesis, within web browsers.
-> ⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source project [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly).
+> ⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source project [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly).
## A Quick Glance
@@ -106,7 +106,7 @@ Please refer to [nostalgist.js.org/apis](https://nostalgist.js.org/apis).
+ [jsDelivr](https://www.jsdelivr.com/)
### Showcases
-+ [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly)
++ [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly)
A web app with which you can build a custom retro gaming library inside your browser.
Game states can be synced with cloud storage services like OneDrive/Google Drive/Dropbox