Skip to content

Commit a38926c

Browse files
Fixed internal styling to align with UI
1 parent f062fb7 commit a38926c

File tree

7 files changed

+714
-74
lines changed

7 files changed

+714
-74
lines changed

README.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
# Mantine Next.js + Nextra template
1+
# Beacon – Next‑Gen Docs for the ResilientDB Ecosystem
22

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.).
34

45
<img width="1536" alt="image" src="https://github.com/user-attachments/assets/eac2e76d-0c63-4429-bb93-b75476e55216" />
56

6-
7-
8-
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
911

1012
## Features
1113

12-
This template comes with the following features:
14+
This project includes the following:
1315

1416
- [PostCSS](https://postcss.org/) with [mantine-postcss-preset](https://mantine.dev/styles/postcss-preset)
1517
- [TypeScript](https://www.typescriptlang.org/)
@@ -20,18 +22,34 @@ This template comes with the following features:
2022

2123
## Nextra Features
2224

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
2730

2831
## Folder structure
2932

3033
- `components` – shared components
3134
- you can use them in both documentation and application
3235
- 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+
```
3447

48+
Build for production:
49+
50+
```bash
51+
npm run build
52+
```
3553

3654
## npm scripts
3755

@@ -55,3 +73,11 @@ This template comes with the following features:
5573
- `storybook` – starts storybook dev server
5674
- `storybook:build` – build production storybook bundle to `storybook-static`
5775
- `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

Comments
 (0)