feat: docs (#26)

* docs: setup Nextra

* feat(docs): ERdoc syntax highlighting in markdown!

* docs: intro, entity, weak entities docs

* docs: relationship and aggregation syntax docs

* fix(Header): Open links in new tab; website title

* spelling

* fix(docs): don't use SVG images. Spelling.

With SVG images, the text of some nodes overflowed when viewing the page
in my laptop

Dockerfile

@@ -31,7 +31,7 @@ ENV NODE_ENV production
 RUN addgroup --system --gid 1001 nodejs
 RUN adduser --system --uid 1001 nextjs
 
-# COPY --from=builder /app/public ./public
+COPY --from=builder /app/public ./public
 
 # Set the correct permission for prerender cache
 RUN mkdir .next

docs.config.tsx

@@ -0,0 +1,25 @@
+import React from "react";
+
+const DocsConfig = {
+  project: {
+    link: "https://github.com/matias-lg/er",
+  },
+  docsRepositoryBase: "https://github.com/matias-lg/er/tree/main",
+  logo: <span style={{ fontWeight: 800 }}>ERdoc Playground</span>,
+  useNextSeoProps: () => ({
+    titleTemplate: "%s",
+  }),
+  footer: {
+    text: (
+      <span>
+        MIT {new Date().getFullYear()} ©{" "}
+        <a href="https://github.com/matias-lg/er" target="_blank">
+          ERdoc Playground
+        </a>
+        .
+      </span>
+    ),
+  },
+};
+
+export default DocsConfig;

next.config.js

@@ -1,3 +1,28 @@
-module.exports = {
+const { getHighlighter, BUNDLED_LANGUAGES } = require("shiki");
+
+const withNextra = require("nextra")({
+  theme: "nextra-theme-docs",
+  themeConfig: "./docs.config.tsx",
+  mdxOptions: {
+    rehypePrettyCodeOptions: {
+      getHighlighter: (options) =>
+        getHighlighter({
+          ...options,
+          langs: [
+            ...BUNDLED_LANGUAGES,
+            // setup syntax highlighting for erdoc code blocks
+            {
+              id: "erdoc",
+              scopeName: "source.erdoc",
+              aliases: ["erdoc"],
+              path: "../../public/erdoc_grammar.tmLanguage.json",
+            },
+          ],
+        }),
+    },
+  },
+});
+
+module.exports = withNextra({
   output: "standalone",
-};
+});