docs : rewrite docs site (#256)

* rewrite docs site using nextra

* updated docs

* updated readme

* add a common issue about sentry and api route

Author: conico974

README.md

@@ -0,0 +1,26 @@
+import { SITE } from "../config";
+import styles from "../styles/Layout.module.css";
+
+export default function Footer() {
+  return (
+    <footer className={styles.footer}>
+      <span>
+        Maintained by{" "}
+        <a target="_blank" href={SITE.sst} rel="noopener noreferrer">
+          SST
+        </a>
+      </span>
+      <div>
+        <a target="_blank" href={SITE.github} rel="noopener noreferrer">
+          GitHub
+        </a>
+        <a target="_blank" href={SITE.discord} rel="noopener noreferrer">
+          Discord
+        </a>
+        <a target="_blank" href={SITE.twitter} rel="noopener noreferrer">
+          Twitter
+        </a>
+      </div>
+    </footer>
+  );
+}

docs/components/Footer.tsx

@@ -1,7 +1,7 @@
 /** @type {import('next').NextConfig} */
 
-let basePath = undefined;
-let assetPrefix = undefined;
+// let basePath = undefined;
+// let assetPrefix = undefined;
 
 ///** Deploys as a directory through GitHub Actions **/
 //const isGithubActions = process.env.GITHUB_ACTIONS || false
@@ -15,16 +15,26 @@ let assetPrefix = undefined;
 //}
 ///** End GitHub Actions case **/
 
-const nextConfig = {
-  images: {
-    unoptimized: true,
-  },
+// const nextConfig = {
+//   images: {
+//     unoptimized: true,
+//   },
 
-  swcMinify: true,
-  reactStrictMode: true,
+//   swcMinify: true,
+//   reactStrictMode: true,
+
+//   basePath: basePath,
+//   assetPrefix: assetPrefix,
+// };
 
-  basePath: basePath,
-  assetPrefix: assetPrefix,
-};
+const withNextra = require("nextra")({
+  theme: "nextra-theme-docs",
+  themeConfig: "./theme.config.jsx",
+});
 
-module.exports = nextConfig;
+module.exports = withNextra({
+  swcMinify: true,
+  images: {
+    unoptimized: true,
+  },
+});

docs/components/Layout.tsx

@@ -13,6 +13,8 @@
     "@types/react": "18.0.25",
     "@types/react-dom": "18.0.9",
     "next": "13.4.12",
+    "nextra": "^2.13.1",
+    "nextra-theme-docs": "^2.13.1",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "typescript": "4.9.3"

docs/next.config.js

@@ -0,0 +1,3 @@
+## Page not found
+
+The page you are looking for does not exist. You can go back to the [homepage](/).

docs/package.json

@@ -0,0 +1,3 @@
+export default function App({ Component, pageProps }) {
+  return <Component {...pageProps} />
+}

docs/pages/404.mdx

@@ -0,0 +1,8 @@
+{
+  "index": "Home",
+  "get_started": "Getting started",
+  "common_issues": "Common issues",
+  "inner_workings": "How does it work?",
+  "advanced": "Advanced",
+  "faq": "FAQ"
+}