refactor: simplify documentation structure by removing multi-language i18n support and unused components
This commit is contained in:
@@ -1,116 +0,0 @@
|
|||||||
---
|
|
||||||
title: Conception de la Base de Données
|
|
||||||
description: MCD, MLD et MPD de MemeGoat.
|
|
||||||
---
|
|
||||||
|
|
||||||
## Modèle Conceptuel des Données (MCD)
|
|
||||||
Le MCD définit les entités et leurs relations.
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
erDiagram
|
|
||||||
UTILISATEUR ||--o{ MEME : "crée"
|
|
||||||
UTILISATEUR ||--o{ COMMENTAIRE : "écrit"
|
|
||||||
MEME ||--o{ COMMENTAIRE : "reçoit"
|
|
||||||
MEME }o--o{ TAG : "possède"
|
|
||||||
|
|
||||||
UTILISATEUR {
|
|
||||||
string pseudo
|
|
||||||
string email
|
|
||||||
string mot_de_passe
|
|
||||||
datetime date_creation
|
|
||||||
}
|
|
||||||
MEME {
|
|
||||||
string titre
|
|
||||||
string url_image
|
|
||||||
datetime date_creation
|
|
||||||
}
|
|
||||||
TAG {
|
|
||||||
string nom
|
|
||||||
}
|
|
||||||
COMMENTAIRE {
|
|
||||||
string contenu
|
|
||||||
datetime date_creation
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Modèle Logique des Données (MLD)
|
|
||||||
Le MLD traduit le MCD en tables avec les clés étrangères.
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
erDiagram
|
|
||||||
users ||--o{ memes : "user_id"
|
|
||||||
users ||--o{ comments : "user_id"
|
|
||||||
memes ||--o{ comments : "meme_id"
|
|
||||||
memes ||--o{ meme_tags : "meme_id"
|
|
||||||
tags ||--o{ meme_tags : "tag_id"
|
|
||||||
|
|
||||||
users {
|
|
||||||
uuid id PK
|
|
||||||
varchar username
|
|
||||||
varchar email
|
|
||||||
text password_hash
|
|
||||||
timestamp created_at
|
|
||||||
}
|
|
||||||
memes {
|
|
||||||
uuid id PK
|
|
||||||
varchar title
|
|
||||||
text image_url
|
|
||||||
uuid user_id FK
|
|
||||||
timestamp created_at
|
|
||||||
}
|
|
||||||
tags {
|
|
||||||
uuid id PK
|
|
||||||
varchar name
|
|
||||||
}
|
|
||||||
meme_tags {
|
|
||||||
uuid meme_id FK
|
|
||||||
uuid tag_id FK
|
|
||||||
}
|
|
||||||
comments {
|
|
||||||
uuid id PK
|
|
||||||
text content
|
|
||||||
uuid user_id FK
|
|
||||||
uuid meme_id FK
|
|
||||||
timestamp created_at
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Modèle Physique des Données (MPD)
|
|
||||||
Implémentation SQL pour PostgreSQL.
|
|
||||||
|
|
||||||
```sql
|
|
||||||
CREATE TABLE users (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
username VARCHAR(50) UNIQUE NOT NULL,
|
|
||||||
email VARCHAR(255) UNIQUE NOT NULL,
|
|
||||||
password_hash TEXT NOT NULL,
|
|
||||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE memes (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
title VARCHAR(255) NOT NULL,
|
|
||||||
image_url TEXT NOT NULL,
|
|
||||||
user_id UUID REFERENCES users(id) ON DELETE SET NULL,
|
|
||||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE tags (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
name VARCHAR(50) UNIQUE NOT NULL
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE meme_tags (
|
|
||||||
meme_id UUID REFERENCES memes(id) ON DELETE CASCADE,
|
|
||||||
tag_id UUID REFERENCES tags(id) ON DELETE CASCADE,
|
|
||||||
PRIMARY KEY (meme_id, tag_id)
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE comments (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
content TEXT NOT NULL,
|
|
||||||
user_id UUID REFERENCES users(id) ON DELETE SET NULL,
|
|
||||||
meme_id UUID REFERENCES memes(id) ON DELETE CASCADE,
|
|
||||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
|
|
||||||
);
|
|
||||||
```
|
|
||||||
@@ -1,116 +0,0 @@
|
|||||||
---
|
|
||||||
title: Database Design
|
|
||||||
description: MCD, MLD and MPD for MemeGoat.
|
|
||||||
---
|
|
||||||
|
|
||||||
## Conceptual Data Model (MCD)
|
|
||||||
The MCD defines entities and their relationships.
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
erDiagram
|
|
||||||
USER ||--o{ MEME : "creates"
|
|
||||||
USER ||--o{ COMMENT : "writes"
|
|
||||||
MEME ||--o{ COMMENT : "receives"
|
|
||||||
MEME }o--o{ TAG : "has"
|
|
||||||
|
|
||||||
USER {
|
|
||||||
string username
|
|
||||||
string email
|
|
||||||
string password
|
|
||||||
datetime created_at
|
|
||||||
}
|
|
||||||
MEME {
|
|
||||||
string title
|
|
||||||
string image_url
|
|
||||||
datetime created_at
|
|
||||||
}
|
|
||||||
TAG {
|
|
||||||
string name
|
|
||||||
}
|
|
||||||
COMMENT {
|
|
||||||
string content
|
|
||||||
datetime created_at
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Logical Data Model (MLD)
|
|
||||||
The MLD translates the MCD into tables with foreign keys.
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
erDiagram
|
|
||||||
users ||--o{ memes : "user_id"
|
|
||||||
users ||--o{ comments : "user_id"
|
|
||||||
memes ||--o{ comments : "meme_id"
|
|
||||||
memes ||--o{ meme_tags : "meme_id"
|
|
||||||
tags ||--o{ meme_tags : "tag_id"
|
|
||||||
|
|
||||||
users {
|
|
||||||
uuid id PK
|
|
||||||
varchar username
|
|
||||||
varchar email
|
|
||||||
text password_hash
|
|
||||||
timestamp created_at
|
|
||||||
}
|
|
||||||
memes {
|
|
||||||
uuid id PK
|
|
||||||
varchar title
|
|
||||||
text image_url
|
|
||||||
uuid user_id FK
|
|
||||||
timestamp created_at
|
|
||||||
}
|
|
||||||
tags {
|
|
||||||
uuid id PK
|
|
||||||
varchar name
|
|
||||||
}
|
|
||||||
meme_tags {
|
|
||||||
uuid meme_id FK
|
|
||||||
uuid tag_id FK
|
|
||||||
}
|
|
||||||
comments {
|
|
||||||
uuid id PK
|
|
||||||
text content
|
|
||||||
uuid user_id FK
|
|
||||||
uuid meme_id FK
|
|
||||||
timestamp created_at
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Physical Data Model (MPD)
|
|
||||||
SQL implementation for PostgreSQL.
|
|
||||||
|
|
||||||
```sql
|
|
||||||
CREATE TABLE users (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
username VARCHAR(50) UNIQUE NOT NULL,
|
|
||||||
email VARCHAR(255) UNIQUE NOT NULL,
|
|
||||||
password_hash TEXT NOT NULL,
|
|
||||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE memes (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
title VARCHAR(255) NOT NULL,
|
|
||||||
image_url TEXT NOT NULL,
|
|
||||||
user_id UUID REFERENCES users(id) ON DELETE SET NULL,
|
|
||||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE tags (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
name VARCHAR(50) UNIQUE NOT NULL
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE meme_tags (
|
|
||||||
meme_id UUID REFERENCES memes(id) ON DELETE CASCADE,
|
|
||||||
tag_id UUID REFERENCES tags(id) ON DELETE CASCADE,
|
|
||||||
PRIMARY KEY (meme_id, tag_id)
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE comments (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
content TEXT NOT NULL,
|
|
||||||
user_id UUID REFERENCES users(id) ON DELETE SET NULL,
|
|
||||||
meme_id UUID REFERENCES memes(id) ON DELETE CASCADE,
|
|
||||||
created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
|
|
||||||
);
|
|
||||||
```
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"title": "Design"
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"title": "Conception"
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
---
|
|
||||||
title: Introduction
|
|
||||||
description: Bienvenue sur MemeGoat, la bibliothèque de MEME et GIF.
|
|
||||||
---
|
|
||||||
|
|
||||||
MemeGoat est un site bibliothèque de MEME et de GIF.
|
|
||||||
Le but est de permettre de retrouver une image adaptée à son besoin par une simple recherche.
|
|
||||||
Il est aussi possible de créer du contenu sur le site.
|
|
||||||
|
|
||||||
## Objectifs
|
|
||||||
- Recherche rapide et intuitive.
|
|
||||||
- Partage de contenu original.
|
|
||||||
- Bibliothèque communautaire.
|
|
||||||
@@ -1,13 +1,13 @@
|
|||||||
---
|
---
|
||||||
title: Introduction
|
title: Hello World
|
||||||
description: Welcome to MemeGoat, the MEME and GIF library.
|
description: Your first document
|
||||||
---
|
---
|
||||||
|
|
||||||
MemeGoat is a MEME and GIF library website.
|
Welcome to the docs! You can start writing documents in `/content/docs`.
|
||||||
The goal is to allow finding an image suited to one's needs through a simple search.
|
|
||||||
It is also possible to create content on the site.
|
|
||||||
|
|
||||||
## Goals
|
## What is Next?
|
||||||
- Fast and intuitive search.
|
|
||||||
- Sharing original content.
|
<Cards>
|
||||||
- Community-driven library.
|
<Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
|
||||||
|
<Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
|
||||||
|
</Cards>
|
||||||
|
|||||||
@@ -1,17 +0,0 @@
|
|||||||
---
|
|
||||||
title: Stack Technique
|
|
||||||
description: Choix technologiques pour MemeGoat.
|
|
||||||
---
|
|
||||||
|
|
||||||
## Frontend
|
|
||||||
- **Framework**: Next.js 15
|
|
||||||
- **Style**: Tailwind CSS
|
|
||||||
- **Bibliothèque UI**: Lucide React, Radix UI
|
|
||||||
|
|
||||||
## Backend
|
|
||||||
- **Langage**: Node.js (TypeScript) / NestJS ou Go
|
|
||||||
- **Base de données**: PostgreSQL
|
|
||||||
- **Stockage d'images**: S3 ou similaire (Cloudinary, Uploadcare)
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
- **Framework**: Fumadocs
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
---
|
|
||||||
title: Tech Stack
|
|
||||||
description: Technological choices for MemeGoat.
|
|
||||||
---
|
|
||||||
|
|
||||||
## Frontend
|
|
||||||
- **Framework**: Next.js 15
|
|
||||||
- **Style**: Tailwind CSS
|
|
||||||
- **UI Library**: Lucide React, Radix UI
|
|
||||||
|
|
||||||
## Backend
|
|
||||||
- **Language**: Node.js (TypeScript) / NestJS or Go
|
|
||||||
- **Database**: PostgreSQL
|
|
||||||
- **Image Storage**: S3 or similar (Cloudinary, Uploadcare)
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
- **Framework**: Fumadocs
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"title": "Stack"
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"title": "Stack"
|
|
||||||
}
|
|
||||||
17
documentation/content/docs/test.mdx
Normal file
17
documentation/content/docs/test.mdx
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
title: Components
|
||||||
|
description: Components
|
||||||
|
---
|
||||||
|
|
||||||
|
## Code Block
|
||||||
|
|
||||||
|
```js
|
||||||
|
console.log('Hello World');
|
||||||
|
```
|
||||||
|
|
||||||
|
## Cards
|
||||||
|
|
||||||
|
<Cards>
|
||||||
|
<Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
|
||||||
|
<Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
|
||||||
|
</Cards>
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "@memegoat/documentation",
|
"name": "@bypass/documentation",
|
||||||
"version": "0.0.1",
|
"version": "0.0.1",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@@ -16,14 +16,11 @@
|
|||||||
"fumadocs-mdx": "14.2.4",
|
"fumadocs-mdx": "14.2.4",
|
||||||
"fumadocs-ui": "16.4.3",
|
"fumadocs-ui": "16.4.3",
|
||||||
"lucide-react": "^0.562.0",
|
"lucide-react": "^0.562.0",
|
||||||
"mermaid": "^11.12.2",
|
|
||||||
"next": "16.1.1",
|
"next": "16.1.1",
|
||||||
"next-themes": "^0.4.6",
|
|
||||||
"react": "^19.2.3",
|
"react": "^19.2.3",
|
||||||
"react-dom": "^19.2.3"
|
"react-dom": "^19.2.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "^2.3.10",
|
|
||||||
"@tailwindcss/postcss": "^4.1.18",
|
"@tailwindcss/postcss": "^4.1.18",
|
||||||
"@types/mdx": "^2.0.13",
|
"@types/mdx": "^2.0.13",
|
||||||
"@types/node": "^24.10.2",
|
"@types/node": "^24.10.2",
|
||||||
@@ -31,6 +28,7 @@
|
|||||||
"@types/react-dom": "^19.2.3",
|
"@types/react-dom": "^19.2.3",
|
||||||
"postcss": "^8.5.6",
|
"postcss": "^8.5.6",
|
||||||
"tailwindcss": "^4.1.18",
|
"tailwindcss": "^4.1.18",
|
||||||
"typescript": "^5.9.3"
|
"typescript": "^5.9.3",
|
||||||
|
"@biomejs/biome": "^2.3.10"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { HomeLayout } from "fumadocs-ui/layouts/home";
|
import { HomeLayout } from "fumadocs-ui/layouts/home";
|
||||||
import { baseOptions } from "@/lib/layout.shared";
|
import { baseOptions } from "@/lib/layout.shared";
|
||||||
|
|
||||||
export default function Layout({ children }: { children: React.ReactNode; params: Promise<{ lang: string }>}) {
|
export default function Layout({ children }: LayoutProps<"/">) {
|
||||||
return <HomeLayout {...baseOptions()}>{children}</HomeLayout>;
|
return <HomeLayout {...baseOptions()}>{children}</HomeLayout>;
|
||||||
}
|
}
|
||||||
@@ -6,7 +6,7 @@ export default function HomePage() {
|
|||||||
<h1 className="text-2xl font-bold mb-4">Hello World</h1>
|
<h1 className="text-2xl font-bold mb-4">Hello World</h1>
|
||||||
<p>
|
<p>
|
||||||
You can open{" "}
|
You can open{" "}
|
||||||
<Link href="/[lang]/docs" className="font-medium underline">
|
<Link href="/docs" className="font-medium underline">
|
||||||
/docs
|
/docs
|
||||||
</Link>{" "}
|
</Link>{" "}
|
||||||
and see the documentation.
|
and see the documentation.
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
import { RootProvider } from "fumadocs-ui/provider/next";
|
|
||||||
import "./global.css";
|
|
||||||
import { Inter } from "next/font/google";
|
|
||||||
import { defineI18nUI } from "fumadocs-ui/i18n";
|
|
||||||
import { i18n } from "@/lib/i18n";
|
|
||||||
|
|
||||||
const inter = Inter({
|
|
||||||
subsets: ["latin"],
|
|
||||||
});
|
|
||||||
|
|
||||||
const { provider } = defineI18nUI(i18n, {
|
|
||||||
translations: {
|
|
||||||
en: {
|
|
||||||
displayName: "English",
|
|
||||||
},
|
|
||||||
fr: {
|
|
||||||
displayName: "French",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
export default async function RootLayout({
|
|
||||||
params,
|
|
||||||
children,
|
|
||||||
}: {
|
|
||||||
params: Promise<{ lang: string }>;
|
|
||||||
children: React.ReactNode;
|
|
||||||
}) {
|
|
||||||
const lang = (await params).lang;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<html lang={lang}>
|
|
||||||
<body className={inter.className}>
|
|
||||||
<RootProvider i18n={provider(lang)}>{children}</RootProvider>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -2,8 +2,6 @@ import { source } from "@/lib/source";
|
|||||||
import { createFromSource } from "fumadocs-core/search/server";
|
import { createFromSource } from "fumadocs-core/search/server";
|
||||||
|
|
||||||
export const { GET } = createFromSource(source, {
|
export const { GET } = createFromSource(source, {
|
||||||
localeMap: {
|
// https://docs.orama.com/docs/orama-js/supported-languages
|
||||||
fr: { language: 'french' },
|
language: "english",
|
||||||
en: { language: 'english' },
|
|
||||||
},
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -10,9 +10,9 @@ import { getMDXComponents } from "@/mdx-components";
|
|||||||
import type { Metadata } from "next";
|
import type { Metadata } from "next";
|
||||||
import { createRelativeLink } from "fumadocs-ui/mdx";
|
import { createRelativeLink } from "fumadocs-ui/mdx";
|
||||||
|
|
||||||
export default async function Page(props: { params: Promise<{ lang: string; slug?: string[]; }> }) {
|
export default async function Page(props: PageProps<"/docs/[[...slug]]">) {
|
||||||
const params = await props.params;
|
const params = await props.params;
|
||||||
const page = source.getPage(params.slug, params.lang);
|
const page = source.getPage(params.slug);
|
||||||
if (!page) notFound();
|
if (!page) notFound();
|
||||||
|
|
||||||
const MDX = page.data.body;
|
const MDX = page.data.body;
|
||||||
@@ -38,10 +38,10 @@ export async function generateStaticParams() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export async function generateMetadata(
|
export async function generateMetadata(
|
||||||
props: PageProps<"/docs/[[...slug]]"> & { params: Promise<{ lang: string; }> },
|
props: PageProps<"/docs/[[...slug]]">,
|
||||||
): Promise<Metadata> {
|
): Promise<Metadata> {
|
||||||
const params = await props.params;
|
const params = await props.params;
|
||||||
const page = source.getPage(params.slug, params.lang);
|
const page = source.getPage(params.slug);
|
||||||
if (!page) notFound();
|
if (!page) notFound();
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -2,7 +2,7 @@ import { source } from "@/lib/source";
|
|||||||
import { DocsLayout } from "fumadocs-ui/layouts/docs";
|
import { DocsLayout } from "fumadocs-ui/layouts/docs";
|
||||||
import { baseOptions } from "@/lib/layout.shared";
|
import { baseOptions } from "@/lib/layout.shared";
|
||||||
|
|
||||||
export default function Layout({ children }: { children: React.ReactNode }) {
|
export default function Layout({ children }: LayoutProps<"/docs">) {
|
||||||
return (
|
return (
|
||||||
<DocsLayout tree={source.getPageTree()} {...baseOptions()}>
|
<DocsLayout tree={source.getPageTree()} {...baseOptions()}>
|
||||||
{children}
|
{children}
|
||||||
17
documentation/src/app/layout.tsx
Normal file
17
documentation/src/app/layout.tsx
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import { RootProvider } from "fumadocs-ui/provider/next";
|
||||||
|
import "./global.css";
|
||||||
|
import { Inter } from "next/font/google";
|
||||||
|
|
||||||
|
const inter = Inter({
|
||||||
|
subsets: ["latin"],
|
||||||
|
});
|
||||||
|
|
||||||
|
export default function Layout({ children }: LayoutProps<"/">) {
|
||||||
|
return (
|
||||||
|
<html lang="en" className={inter.className} suppressHydrationWarning>
|
||||||
|
<body className="flex flex-col min-h-screen">
|
||||||
|
<RootProvider>{children}</RootProvider>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -17,7 +17,7 @@ export async function GET(
|
|||||||
<DefaultImage
|
<DefaultImage
|
||||||
title={page.data.title}
|
title={page.data.title}
|
||||||
description={page.data.description}
|
description={page.data.description}
|
||||||
site="MemeGoat"
|
site="My App"
|
||||||
/>,
|
/>,
|
||||||
{
|
{
|
||||||
width: 1200,
|
width: 1200,
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
'use client';
|
|
||||||
|
|
||||||
import { use, useEffect, useId, useState } from 'react';
|
|
||||||
import { useTheme } from 'next-themes';
|
|
||||||
|
|
||||||
export function Mermaid({ chart }: { chart: string }) {
|
|
||||||
const [mounted, setMounted] = useState(false);
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
setMounted(true);
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
if (!mounted) return;
|
|
||||||
return <MermaidContent chart={chart} />;
|
|
||||||
}
|
|
||||||
|
|
||||||
const cache = new Map<string, Promise<unknown>>();
|
|
||||||
|
|
||||||
function cachePromise<T>(key: string, setPromise: () => Promise<T>): Promise<T> {
|
|
||||||
const cached = cache.get(key);
|
|
||||||
if (cached) return cached as Promise<T>;
|
|
||||||
|
|
||||||
const promise = setPromise();
|
|
||||||
cache.set(key, promise);
|
|
||||||
return promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
function MermaidContent({ chart }: { chart: string }) {
|
|
||||||
const id = useId();
|
|
||||||
const { resolvedTheme } = useTheme();
|
|
||||||
const { default: mermaid } = use(cachePromise('mermaid', () => import('mermaid')));
|
|
||||||
|
|
||||||
mermaid.initialize({
|
|
||||||
startOnLoad: false,
|
|
||||||
securityLevel: 'loose',
|
|
||||||
fontFamily: 'inherit',
|
|
||||||
themeCSS: 'margin: 1.5rem auto 0;',
|
|
||||||
theme: resolvedTheme === 'dark' ? 'dark' : 'default',
|
|
||||||
});
|
|
||||||
|
|
||||||
const { svg, bindFunctions } = use(
|
|
||||||
cachePromise(`${chart}-${resolvedTheme}`, () => {
|
|
||||||
return mermaid.render(id, chart.replaceAll('\\n', '\n'));
|
|
||||||
}),
|
|
||||||
);
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div
|
|
||||||
ref={(container) => {
|
|
||||||
if (container) bindFunctions?.(container);
|
|
||||||
}}
|
|
||||||
// biome-ignore lint/security/noDangerouslySetInnerHtml: correct usage.
|
|
||||||
dangerouslySetInnerHTML={{ __html: svg }}
|
|
||||||
/>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
import { defineI18n } from "fumadocs-core/i18n";
|
|
||||||
|
|
||||||
export const i18n = defineI18n({
|
|
||||||
defaultLanguage: "en",
|
|
||||||
languages: ["en", "fr"],
|
|
||||||
});
|
|
||||||
@@ -1,11 +1,9 @@
|
|||||||
import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
|
import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
|
||||||
import {i18n} from "@/lib/i18n";
|
|
||||||
|
|
||||||
export function baseOptions(): BaseLayoutProps {
|
export function baseOptions(): BaseLayoutProps {
|
||||||
return {
|
return {
|
||||||
i18n,
|
|
||||||
nav: {
|
nav: {
|
||||||
title: "MemeGoat",
|
title: "My App",
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,11 +1,9 @@
|
|||||||
import { docs } from "fumadocs-mdx:collections/server";
|
import { docs } from "fumadocs-mdx:collections/server";
|
||||||
import { type InferPageType, loader } from "fumadocs-core/source";
|
import { type InferPageType, loader } from "fumadocs-core/source";
|
||||||
import { lucideIconsPlugin } from "fumadocs-core/source/lucide-icons";
|
import { lucideIconsPlugin } from "fumadocs-core/source/lucide-icons";
|
||||||
import {i18n} from "@/lib/i18n";
|
|
||||||
|
|
||||||
// See https://fumadocs.dev/docs/headless/source-api for more info
|
// See https://fumadocs.dev/docs/headless/source-api for more info
|
||||||
export const source = loader({
|
export const source = loader({
|
||||||
i18n,
|
|
||||||
baseUrl: "/docs",
|
baseUrl: "/docs",
|
||||||
source: docs.toFumadocsSource(),
|
source: docs.toFumadocsSource(),
|
||||||
plugins: [lucideIconsPlugin()],
|
plugins: [lucideIconsPlugin()],
|
||||||
|
|||||||
@@ -1,22 +1,9 @@
|
|||||||
import defaultMdxComponents from "fumadocs-ui/mdx";
|
import defaultMdxComponents from "fumadocs-ui/mdx";
|
||||||
import type { MDXComponents } from "mdx/types";
|
import type { MDXComponents } from "mdx/types";
|
||||||
import { Mermaid } from "@/components/mdx/mermaid";
|
|
||||||
|
|
||||||
export function getMDXComponents(components?: MDXComponents): MDXComponents {
|
export function getMDXComponents(components?: MDXComponents): MDXComponents {
|
||||||
return {
|
return {
|
||||||
...defaultMdxComponents,
|
...defaultMdxComponents,
|
||||||
...components,
|
...components,
|
||||||
pre: ({ children, ...props }: any) => {
|
|
||||||
if (
|
|
||||||
children &&
|
|
||||||
typeof children === "object" &&
|
|
||||||
"type" in children &&
|
|
||||||
(children as any).type === "code" &&
|
|
||||||
(children as any).props.className === "language-mermaid"
|
|
||||||
) {
|
|
||||||
return <Mermaid chart={(children as any).props.children} />;
|
|
||||||
}
|
|
||||||
return <defaultMdxComponents.pre {...props}>{children}</defaultMdxComponents.pre>;
|
|
||||||
},
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +0,0 @@
|
|||||||
import { createI18nMiddleware } from "fumadocs-core/i18n/middleware";
|
|
||||||
import { i18n } from "@/lib/i18n";
|
|
||||||
|
|
||||||
export default createI18nMiddleware(i18n);
|
|
||||||
|
|
||||||
export const config = {
|
|
||||||
// Matcher ignoring `/_next/` and `/api/`
|
|
||||||
//TODO Adjust it to ignore static assets in `/public` folder
|
|
||||||
matcher: ["/((?!api|_next/static|_next/image|favicon.ico).*)"],
|
|
||||||
};
|
|
||||||
Reference in New Issue
Block a user