Skip to content

Commit

Permalink
升级文档
Browse files Browse the repository at this point in the history
  • Loading branch information
lilingfengdev authored Nov 24, 2024
1 parent fc3bd5c commit c2f76bc
Show file tree
Hide file tree
Showing 22 changed files with 740 additions and 139 deletions.
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

9 changes: 0 additions & 9 deletions docs-bedrock/bds-core/preparation/text-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@ title: 文本编辑器
sidebar_position: 2
---

:::tip
本篇文档已完成编写!<br />
支持后续 PR

# Biggest SUCCESS

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# 文本编辑器

请见 [通用 | 文本编辑器](https://nitwikit.yizhan.wiki/preparation/text-editor)
9 changes: 0 additions & 9 deletions docs-bedrock/bds-core/preparation/websites.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@ title: 可能用到的网站
sidebar_position: 1
---

:::tip
本篇文档已完成编写!<br />
支持后续 PR

# Biggest SUCCESS

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# 可能用到的网站

开服不能只是从某一网站或者简单百度、Bing、谷歌获取资源,这样获取的资源种类非常贫乏。
Expand Down
5 changes: 0 additions & 5 deletions docs-bedrock/bds-core/process/BDSX/bdsx-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
title: BDSX 安装教程
sidebar_position: 1
---
:::info

作者:[雪风先生](https://github.com/virgil698)

:::

# BDSX 安装教程

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
title: LeviLamina 安装教程
sidebar_position: 1
---
:::info

作者:[星凌QAQ](https://github.com/XingLingQAQ)

:::

# LeviLamina 安装教程

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
title: 插件安装教程
sidebar_position: 1
---
:::info

作者:[星凌QAQ](https://github.com/XingLingQAQ)

:::

# 插件安装教程

Expand Down
9 changes: 0 additions & 9 deletions docs-bedrock/bds-core/process/plugins/how-to-load-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,4 @@ title: 如何加载插件
sidebar_position: 1
---

:::warning
本篇文档持续更新中...<br />
支持后续 PR

# Biggest TODO

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# TODO
9 changes: 0 additions & 9 deletions docs-bedrock/bds-core/process/plugins/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@ title: 插件
sidebar_position: 1
---

:::warning
本篇文档持续更新中...<br />
支持后续 PR

# Biggest TODO

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# 插件

**本文档中提到的插件都有较多用户基础和完善的 Wiki,具体插件请查看插件的 Wiki。**
Expand Down
9 changes: 0 additions & 9 deletions docs-bedrock/bds-core/start/basic/server-file-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@ title: 服务端结构
sidebar_position: 1
---

:::tip
本篇文档已完成编写!<br />
支持后续 PR

# Biggest SUCCESS

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# 服务端结构

我们先来简单看一眼 BDS **开服后** 的文件夹结构:
Expand Down
9 changes: 0 additions & 9 deletions docs-bedrock/nukkit-core/preparation/todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,4 @@ title: TODO
sidebar_position: 1
---

:::warning
本篇文档持续更新中...<br />
支持后续 PR

# Biggest TODO

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# TODO
9 changes: 0 additions & 9 deletions docs-bedrock/pnx-core/preparation/todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,4 @@ title: TODO
sidebar_position: 1
---

:::warning
本篇文档持续更新中...<br />
支持后续 PR

# Biggest TODO

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# TODO
9 changes: 0 additions & 9 deletions docs-bedrock/super-basic/server-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,6 @@ sidebar_position: 2

<!-- markdownlint-disable no-duplicate-heading -->

:::tip
本篇文档已完成编写!<br />
支持后续 PR

# Biggest SUCCESS

作者:[梦涵LOVE](https://github.com/MengHanLOVE1027)
:::

# 服务器类型

> 目前有五类主流的选择: 纯净服(又名原版服),Addon 服(仅 BDS),插件服,小游戏服(插件服的一种),Addon 和 插件混合服(仅 BDS)。
Expand Down
1 change: 1 addition & 0 deletions docs-bedrock/super-basic/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 服务器版本选择
sidebar_position: 4
---

# 选择合适的版本

先说结论:如果没有明确需求,**选择对应服务端的最新版即可。** 最新版的服务端往往支持最新版的客户端进入。
Expand Down
27 changes: 25 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ import { themes as prismThemes } from "prism-react-renderer";

/** @type {import('@docusaurus/types').Config} */
const config = {
future: {
experimental_faster: true,
},

customFields: {
// 标题前缀
titlePrefix: "主页",
Expand Down Expand Up @@ -64,12 +68,16 @@ const config = {
},
blog: false,
theme: {
customCss: require.resolve('./src/css/custom.css'),
customCss: [
require.resolve('./src/css/custom.css'),
],
},
}),
],
],
plugins: [
'docusaurus-plugin-image-zoom',
'docusaurus-plugin-sass',
[
'@docusaurus/plugin-content-docs',
{
Expand Down Expand Up @@ -133,6 +141,13 @@ const config = {
category: 'Announcements',
categoryId: 'DIC_kwDOLkVR-M4CkTAe'
},
zoom: {
selector: '.markdown :not(em) > img',
background: {
light: 'rgb(255, 255, 255)',
dark: 'rgb(50, 50, 50)',
},
},
// 标题渲染范围
tableOfContents: {
minHeadingLevel: 2,
Expand All @@ -156,7 +171,7 @@ const config = {
alt: 'Logo',
src: 'img/book.png',
},
hideOnScroll: false,
hideOnScroll: true,
items: [
{
type: 'doc',
Expand Down Expand Up @@ -196,6 +211,7 @@ const config = {
// },
],
},

// 底部链接
footer: {
style: 'dark',
Expand Down Expand Up @@ -285,6 +301,13 @@ const config = {

themes: [
'@docusaurus/theme-mermaid'

],
scripts: [
{
src: '/autoload.js',
defer: true,
},
],
};

Expand Down
15 changes: 11 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"dependencies": {
"@ant-design/icons": "^5.5.1",
"@docusaurus/core": "^3.6.1",
"@docusaurus/faster": "^3.6.2",
"@docusaurus/plugin-content-docs": "^3.6.1",
"@docusaurus/plugin-debug": "^3.6.1",
"@docusaurus/plugin-pwa": "^3.6.1",
Expand All @@ -28,18 +29,24 @@
"@docusaurus/theme-mermaid": "^3.6.1",
"@docusaurus/theme-search-algolia": "^3.6.1",
"@giscus/react": "^3.0.0",
"@mdx-js/react": "3.0.1",
"@mdx-js/react": "^3.1.0",
"antd": "^5.21.2",
"clsx": "2.1.1",
"clsx": "^2.1.1",
"docusaurus-plugin-image-zoom": "^2.0.0",
"docusaurus-plugin-sass": "^0.2.5",
"mitt": "^3.0.1",
"pnpm": "^9.13.2",
"prism-react-renderer": "^2.3.1",
"react": "18.3.1",
"react-dom": "18.3.1"
"react": "^18.3.1",
"react-dom": "^18.3.1",
"sass": "^1.81.0",
"tailwind-merge": "^2.3.0",
"tailwindcss": "^3.4.4"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/types": "^3.5.2",
"@tailwindcss/typography": "^0.5.13",
"markdownlint-cli2": "^0.14.0"
},
"browserslist": {
Expand Down
11 changes: 11 additions & 0 deletions rspack.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

const isDev = process.env.NODE_ENV === 'development';
module.exports = {
experiments: {
futureDefaults: true,
asyncWebAssembly: true,
css: true,
lazyCompilation: isDev,
incremental: isDev,
},
};
Loading

0 comments on commit c2f76bc

Please sign in to comment.