🎉 Initial Setup
This commit is contained in:
parent
148aac5a92
commit
5e33947060
45
README.md
45
README.md
@ -1,45 +0,0 @@
|
|||||||
# solardocs
|
|
||||||
|
|
||||||
This is a Next.js application generated with
|
|
||||||
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
|
|
||||||
|
|
||||||
Run development server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run dev
|
|
||||||
# or
|
|
||||||
pnpm dev
|
|
||||||
# or
|
|
||||||
yarn dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Open http://localhost:3000 with your browser to see the result.
|
|
||||||
|
|
||||||
## Explore
|
|
||||||
|
|
||||||
In the project, you can see:
|
|
||||||
|
|
||||||
- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
|
|
||||||
- `app/layout.config.tsx`: Shared options for layouts, optional but preferred to keep.
|
|
||||||
|
|
||||||
| Route | Description |
|
|
||||||
| ------------------------- | ------------------------------------------------------ |
|
|
||||||
| `app/(home)` | The route group for your landing page and other pages. |
|
|
||||||
| `app/docs` | The documentation layout and pages. |
|
|
||||||
| `app/api/search/route.ts` | The Route Handler for search. |
|
|
||||||
|
|
||||||
### Fumadocs MDX
|
|
||||||
|
|
||||||
A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
|
|
||||||
|
|
||||||
Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
|
|
||||||
|
|
||||||
## Learn More
|
|
||||||
|
|
||||||
To learn more about Next.js and Fumadocs, take a look at the following
|
|
||||||
resources:
|
|
||||||
|
|
||||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
|
|
||||||
features and API.
|
|
||||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
|
||||||
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs
|
|
@ -1,13 +1,41 @@
|
|||||||
---
|
---
|
||||||
title: Hello World
|
title: Hello World
|
||||||
description: Your first document
|
description: 欢迎来到 Solar Network 的世界
|
||||||
---
|
---
|
||||||
|
|
||||||
Welcome to the docs! You can start writing documents in `/content/docs`.
|
import { GithubInfo } from 'fumadocs-ui/components/github-info';
|
||||||
|
|
||||||
## What is Next?
|
-------
|
||||||
|
|
||||||
<Cards>
|
欢迎来到 Solar Network 用户手册。这份手册旨在帮助您开始使用 Solar Network。
|
||||||
<Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
|
|
||||||
<Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
|
Solar Network 是一个开源的社交网络。
|
||||||
</Cards>
|
~~其目标的竞争对手是 Google 而不是 Mastodon 等其他的去中心化社交网络。~~
|
||||||
|
|
||||||
|
其的服务器和客户端项目都基于 AGPLv3 协议开源,你可以在侧边栏顶部看到项目地址。
|
||||||
|
|
||||||
|
-------
|
||||||
|
|
||||||
|
## 基础知识
|
||||||
|
|
||||||
|
Solar Network 是整个 HyperNet 项目的别称,它分为 HyperNet 服务器和用户经常使用的 Surface 应用(在市场上又名 Solian)。
|
||||||
|
|
||||||
|
你可以将 Solar Network 简写为 SN,大小写均可。但是在提及到它的应用程式时,请确保首字母大写。
|
||||||
|
|
||||||
|
- Solian ✅
|
||||||
|
- Solar Network ✅
|
||||||
|
- SN ✅
|
||||||
|
- sn ✅
|
||||||
|
- solian ❌
|
||||||
|
- SOLIAN ❌
|
||||||
|
|
||||||
|
~~虽然你乱用 SN 的名字我也不能把你怎样,但是你用对名字总能让小羊看的舒服一点~~
|
||||||
|
|
||||||
|
## 开始使用
|
||||||
|
|
||||||
|
对于终端用户(End-user),开始使用 Solar Network 有几种方式:
|
||||||
|
|
||||||
|
- [安装 Solian 客户端](./installation) **最推荐**
|
||||||
|
- [在网页版打开 Solian](https://sn.solsynth.dev)
|
||||||
|
|
||||||
|
为了探索完整的 Solar Network 功能,你需要一个 Solarpass 账户(又称太阳通行证)。
|
||||||
|
@ -1,18 +1,18 @@
|
|||||||
import Link from 'next/link';
|
import Link from "next/link";
|
||||||
|
|
||||||
export default function HomePage() {
|
export default function HomePage() {
|
||||||
return (
|
return (
|
||||||
<main className="flex flex-1 flex-col justify-center text-center">
|
<main className="flex flex-1 flex-col justify-center text-center">
|
||||||
<h1 className="mb-4 text-2xl font-bold">Hello World</h1>
|
<h1 className="mb-4 text-2xl font-bold">Ciallo ~(∠・ω< )⌒★!</h1>
|
||||||
<p className="text-fd-muted-foreground">
|
<p className="text-fd-muted-foreground">
|
||||||
You can open{' '}
|
虽然不知道你是为什么会来到这个首页,但是你应该可以点击{" "}
|
||||||
<Link
|
<Link
|
||||||
href="/docs"
|
href="/docs"
|
||||||
className="text-fd-foreground font-semibold underline"
|
className="text-fd-foreground font-semibold underline"
|
||||||
>
|
>
|
||||||
/docs
|
/docs
|
||||||
</Link>{' '}
|
</Link>{" "}
|
||||||
and see the documentation.
|
来看真正的文档内容。
|
||||||
</p>
|
</p>
|
||||||
</main>
|
</main>
|
||||||
);
|
);
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
|
import { GithubInfo } from "fumadocs-ui/components/github-info";
|
||||||
|
import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Shared layout configurations
|
* Shared layout configurations
|
||||||
@ -11,18 +12,21 @@ export const baseOptions: BaseLayoutProps = {
|
|||||||
nav: {
|
nav: {
|
||||||
title: (
|
title: (
|
||||||
<>
|
<>
|
||||||
<svg
|
<img
|
||||||
|
src="https://solsynth.dev/icon.png"
|
||||||
width="24"
|
width="24"
|
||||||
height="24"
|
height="24"
|
||||||
xmlns="http://www.w3.org/2000/svg"
|
alt="Solardocs Logo"
|
||||||
aria-label="Logo"
|
/>
|
||||||
>
|
Solardocs
|
||||||
<circle cx={12} cy={12} r={12} fill="currentColor" />
|
|
||||||
</svg>
|
|
||||||
My App
|
|
||||||
</>
|
</>
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
// see https://fumadocs.dev/docs/ui/navigation/links
|
// see https://fumadocs.dev/docs/ui/navigation/links
|
||||||
links: [],
|
links: [
|
||||||
|
{
|
||||||
|
type: "custom",
|
||||||
|
children: <GithubInfo owner="Solsynth" repo="Solian" />,
|
||||||
|
},
|
||||||
|
],
|
||||||
};
|
};
|
||||||
|
@ -1,17 +1,21 @@
|
|||||||
import './global.css';
|
import { Banner } from "fumadocs-ui/components/banner";
|
||||||
import { RootProvider } from 'fumadocs-ui/provider';
|
import "./global.css";
|
||||||
import { Inter } from 'next/font/google';
|
import { RootProvider } from "fumadocs-ui/provider";
|
||||||
import type { ReactNode } from 'react';
|
import { Inter } from "next/font/google";
|
||||||
|
import type { ReactNode } from "react";
|
||||||
|
|
||||||
const inter = Inter({
|
const inter = Inter({
|
||||||
subsets: ['latin'],
|
subsets: ["latin"],
|
||||||
});
|
});
|
||||||
|
|
||||||
export default function Layout({ children }: { children: ReactNode }) {
|
export default function Layout({ children }: { children: ReactNode }) {
|
||||||
return (
|
return (
|
||||||
<html lang="en" className={inter.className} suppressHydrationWarning>
|
<html lang="en" className={inter.className} suppressHydrationWarning>
|
||||||
<body className="flex flex-col min-h-screen">
|
<body className="flex flex-col min-h-screen">
|
||||||
<RootProvider>{children}</RootProvider>
|
<RootProvider>
|
||||||
|
<Banner id="solar-network-v3-initial" variant="rainbow">Solar Network v3 现已发布</Banner>
|
||||||
|
{children}
|
||||||
|
</RootProvider>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
);
|
);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user