You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-10Lines changed: 36 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,17 @@
1
-
# Mantine Next.js + Nextra template
1
+
# Beacon – Next‑Gen Docs for the ResilientDB Ecosystem
2
2
3
+
Beacon is a modern documentation and application shell built with the Next.js App Router, Mantine UI, and the Nextra Docs theme. It powers the ResilientDB docs experience with a custom landing page, synchronized dark/light theming between Mantine and Nextra, and a growing set of interactive examples (TypeScript and Python playgrounds, IDE embeds, etc.).
This is a template for [Next.js](https://nextjs.org/) app router + [Mantine](https://mantine.dev/) + [Nextra](https://nextra.site/) documentation site.
7
+
Key goals:
8
+
- Provide a fast, consistent docs experience for the ResilientDB ecosystem
9
+
- Keep the UI simple and readable while supporting rich, interactive content
10
+
- Ensure theming is consistent across the landing page and Nextra-powered docs
9
11
10
12
## Features
11
13
12
-
This template comes with the following features:
14
+
This project includes the following:
13
15
14
16
-[PostCSS](https://postcss.org/) with [mantine-postcss-preset](https://mantine.dev/styles/postcss-preset)
15
17
-[TypeScript](https://www.typescriptlang.org/)
@@ -20,18 +22,34 @@ This template comes with the following features:
20
22
21
23
## Nextra Features
22
24
23
-
-[Nextra](https://nextra.site/) documentation site with Mantine theme
24
-
- Sync Dark mode between documentation and application (Mantine/Nextra)
25
-
- Customizable components in `components` folder
26
-
- Provides new Navigation and Footer components for Nextra documentation site
25
+
-[Nextra](https://nextra.site/) documentation site using the Docs theme
26
+
- Theme sync between Mantine and Nextra (dark mode by default)
27
+
- Customizable UI in `components/` (Navbar, Footer, ColorScheme controls)
28
+
- Custom landing page in `app/page.tsx` with Mantine components
29
+
- Interactive examples (TypeScript/Python playgrounds) and MDX-driven content
27
30
28
31
## Folder structure
29
32
30
33
-`components` – shared components
31
34
- you can use them in both documentation and application
32
35
- you may customize them to fit your needs
33
-
-`content` – Nextra documentation site (.mdx and _meta.json files)
36
+
-`content` – Nextra documentation site (.mdx and _meta files)
37
+
38
+
39
+
## Getting started
40
+
41
+
Install dependencies and run the dev server:
42
+
43
+
```bash
44
+
npm i
45
+
npm run dev
46
+
```
34
47
48
+
Build for production:
49
+
50
+
```bash
51
+
npm run build
52
+
```
35
53
36
54
## npm scripts
37
55
@@ -55,3 +73,11 @@ This template comes with the following features:
55
73
-`storybook` – starts storybook dev server
56
74
-`storybook:build` – build production storybook bundle to `storybook-static`
57
75
-`prettier:write` – formats all files with Prettier
76
+
77
+
## Contributing
78
+
79
+
Issues and PRs are welcome. Keep edits focused and match the existing code style. For UI changes, prefer small, composable CSS updates (ideally inside `app/global.css` under `@layer nextra`) that play nicely with Nextra’s cascade.
80
+
81
+
## TODO
82
+
83
+
- Fix light mode (align backgrounds and content in Nextra with landing page)
0 commit comments