Skip to content

Commit

Permalink
fix: some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
@hua0512
hua0512 committed Nov 7, 2024
1 parent d02f7a8 commit cd9e41d
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 41 deletions.
41 changes: 23 additions & 18 deletions docs/.vitepress/locales/en.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { createRequire } from "module";
import { defineConfig } from "vitepress";
import {createRequire} from "module";
import {defineConfig} from "vitepress";

const require = createRequire(import.meta.url);
const pkg = require("vitepress/package.json");
Expand All @@ -11,65 +11,70 @@ export default defineConfig({
themeConfig: {
nav: nav(),

lastUpdatedText: "last Updated",
lastUpdated: {
text: "Last Updated",
formatOptions: {
forceLocale: true,
}
},

sidebar: sidebarGuide(),

socialLinks: [
{ icon: "github", link: "https://github.com/stream-rec/stream-rec" },
{icon: "github", link: "https://github.com/stream-rec/stream-rec"},
],

footer: {
message:
'Released under the <a href="https://github.com/stream-rec/stream-rec/blob/main/LICENSE">MIT License</a>.',
'Released under the <a href="https://github.com/stream-rec/stream-rec/blob/main/LICENSE">MIT License</a>.',
copyright:
'Copyright © 2024-present <a href="https://github.com/hua0512">@hua0512</a>',
'Copyright © 2024-present <a href="https://github.com/hua0512">@hua0512</a>',
},

editLink: {
pattern:
"https://github.com/stream-rec/stream-rec-pages/edit/main/docs/:path",
"https://github.com/stream-rec/stream-rec-pages/edit/main/docs/:path",
text: "Edit this page on GitHub",
},
},
});

function nav() {
return [{ text: "Home", link: "/" }];
return [{text: "Home", link: "/"}];
}

function sidebarGuide() {
return [
{
text: "Get Started",
items: [
{ text: "What is Stream-rec", link: "/what-is-stream-rec" },
{ text: "Supported platforms", link: "/supported-platforms" },
{ text: "Installation", link: "/installation" },
{ text: "Changelog", link: "/changelog" },
{text: "What is Stream-rec", link: "/what-is-stream-rec"},
{text: "Supported platforms", link: "/supported-platforms"},
{text: "Installation", link: "/installation"},
{text: "Changelog", link: "/changelog"},
],
},
{
text: "Usage",
items: [
{ text: "Engines", link: "/engines" },
{ text: "Configuration", link: "/configuration" },
{text: "Engines", link: "/engines"},
{text: "Configuration", link: "/configuration"},
// { text: "Advanced usage", link: "/advanced-usage" },
// { text: "FAQ", link: "/faq" },
],
},
{
text: "Api Reference",
collapsed: true,
items: [{ text: "Api guide", link: "/api-guide" }],
items: [{text: "Api guide", link: "/api-guide"}],
},

{
text: "About",
items: [
{ text: "Contributing", link: "/contributing" },
{ text: "Credits", link: "/credits" },
{ text: "License", link: "/license" },
{text: "Contributing", link: "/contributing"},
{text: "Credits", link: "/credits"},
{text: "License", link: "/license"},
],
},
];
Expand Down
41 changes: 23 additions & 18 deletions docs/.vitepress/locales/zh_CN.ts
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { createRequire } from "module";
import { defineConfig } from "vitepress";
import {createRequire} from "module";
import {defineConfig} from "vitepress";

const require = createRequire(import.meta.url);
const pkg = require("vitepress/package.json");
Expand All @@ -11,65 +11,70 @@ export default defineConfig({
themeConfig: {
nav: nav(),

lastUpdatedText: "最后更新",
lastUpdated: {
text: "最后更新",
formatOptions: {
forceLocale: true,
}
},

sidebar: sidebarGuide(),

socialLinks: [
{ icon: "github", link: "https://github.com/stream-rec/stream-rec" },
{icon: "github", link: "https://github.com/stream-rec/stream-rec"},
],

footer: {
message:
'在 <a href="https://github.com/stream-rec/stream-rec/blob/main/LICENSE">MIT License</a> 许可证下发布。',
'在 <a href="https://github.com/stream-rec/stream-rec/blob/main/LICENSE">MIT License</a> 许可证下发布。',
copyright:
'Copyright © 2024-现在 <a href="https://github.com/hua0512">@hua0512</a>',
'Copyright © 2024-现在 <a href="https://github.com/hua0512">@hua0512</a>',
},

editLink: {
pattern:
"https://github.com/stream-rec/stream-rec-pages/edit/main/docs/:path",
"https://github.com/stream-rec/stream-rec-pages/edit/main/docs/:path",
text: "在 GitHub 中编辑本页",
},
},
});

function nav() {
return [{ text: "主页", link: "/" }];
return [{text: "主页", link: "/"}];
}

function sidebarGuide() {
return [
{
text: "开始",
items: [
{ text: "介绍", link: "/zh_CN/what-is-stream-rec" },
{ text: "平台支持", link: "/zh_CN/supported-platforms" },
{ text: "安装", link: "/zh_CN/installation" },
{ text: "更新日志", link: "/zh_CN/changelog" },
{text: "介绍", link: "/zh_CN/what-is-stream-rec"},
{text: "平台支持", link: "/zh_CN/supported-platforms"},
{text: "安装", link: "/zh_CN/installation"},
{text: "更新日志", link: "/zh_CN/changelog"},
],
},
{
text: "使用",
items: [
{ text: "下载引擎", link: "/zh_CN/engines" },
{ text: "配置", link: "/zh_CN/configuration" },
{text: "下载引擎", link: "/zh_CN/engines"},
{text: "配置", link: "/zh_CN/configuration"},
// { text: "Advanced usage", link: "/zh_CN/advanced-usage" },
// { text: "FAQ", link: "/zh_CN/faq" },
],
},
{
text: "开发者",
collapsed: true,
items: [{ text: "Api 文档", link: "/zh_CN/api-guide" }],
items: [{text: "Api 文档", link: "/zh_CN/api-guide"}],
},

{
text: "关于",
items: [
{ text: "贡献", link: "/zh_CN/contributing" },
{ text: "感谢", link: "/zh_CN/credits" },
{ text: "许可证", link: "/zh_CN/license" },
{text: "贡献", link: "/zh_CN/contributing"},
{text: "感谢", link: "/zh_CN/credits"},
{text: "许可证", link: "/zh_CN/license"},
],
},
];
Expand Down
10 changes: 5 additions & 5 deletions docs/zh_CN/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: home

hero:
name: "Stream-rec"
text: "全自动录播, 多平台支持"
text: "全自动录播工具"
tagline: "多平台流媒体录制"
image:
src: /stream-rec.svg
Expand All @@ -14,18 +14,18 @@ hero:
actions:
- theme: brand
text: 开始使用
link: /what-is-stream-rec
link: /zh_CN/what-is-stream-rec
- theme: alt
text: 开发者文档
link: /api-guide
link: /zh_CN/api-guide

features:
- title: 多平台支持
details: 支持 虎牙、斗鱼、抖音、Twitch等多个平台
- title: 前后端分离
details: 前端使用 React + Nextjs, 后端使用 Kotlin + Ktor
- title: 定时录制
details: 允许用户设置录制时间
details: 允许用户设置录制时间段，减少平台API调用次数，提高录制效率
- title: 容器化部署
details: Stream-rec 可以作为 Docker 容器部署, 方便设置和管理
details: Stream-rec 首推 Docker 部署，方便快捷。
---

0 comments on commit cd9e41d

Please sign in to comment.