feat: update docs

yuanze-dev · Aug 5, 2024 · 7a73765 · 7a73765
1 parent 5176516
commit 7a73765
Show file tree

Hide file tree

Showing 30 changed files with 440 additions and 374 deletions.
diff --git a/.vitepress/config.mjs b/.vitepress/config.mjs
@@ -39,6 +39,7 @@ export default defineConfig({
         text: "基础教程",
         collapsed: false,
         items: [
+          { text: "😃 芦笋直播助手介绍", link: "/basic/introduction" },
           { text: "🚀 如何 3 步开始直播", link: "/basic/how-to-start" },
           { text: "🔐 如何获取推流码", link: "/basic/streaming-code" },
         ],

diff --git a/.vitepress/theme/custom.css b/.vitepress/theme/custom.css
@@ -1,23 +1,27 @@
 /* .vitepress/theme/custom.css */
 :root {
-  --vp-c-brand-1: #69C71B;
-  --vp-c-brand-2: #2F8F00;
+  --vp-c-brand-1: #69c71b;
+  --vp-c-brand-2: #2f8f00;
 }
 
 /* 文章样式调整 */
 
 /* 标题上下边距 */
-.vp-doc h2, .vp-doc h3, .vp-doc h4 {
+.vp-doc h2,
+.vp-doc h3,
+.vp-doc h4 {
   margin: 1em 0;
 }
 
 /* 表格顶部对齐 */
-.vp-doc table > tbody > tr > td{
-  vertical-align: top
+.vp-doc table > tbody > tr > td {
+  vertical-align: top;
 }
 
 /* 内容居中 */
-.vp-doc th, .vp-doc tr, .vp-doc td {
+.vp-doc th,
+.vp-doc tr,
+.vp-doc td {
   text-align: center;
 }
 
@@ -26,7 +30,6 @@
   width: 100%;
 }
 
-
 /* 图片点击放大 */
 .medium-zoom-overlay {
   z-index: 30;
@@ -49,25 +52,25 @@
 }
 
 /* 目录样式 */
-#VPSidebarNav section.VPSidebarItem div.items{
+#VPSidebarNav section.VPSidebarItem div.items {
   border-left: none;
 }
 
 /* 目录激活样式 */
-#VPSidebarNav div.VPSidebarItem.is-active div{
+#VPSidebarNav div.VPSidebarItem.is-active div {
   background-color: transparent;
 }
 
 /* 联系我们 */
-#VPSidebarNav > div:nth-child(5) > section > div > div > div > a > p {
+#VPSidebarNav > div:nth-child(3) > section > div > div > div > a > p {
   color: var(--vp-c-text-1);
   margin-left: -1em;
   font-weight: 700;
 }
-#VPSidebarNav > div:nth-child(5) > section > div > div > div > a > p:hover {
+#VPSidebarNav > div:nth-child(3) > section > div > div > div > a > p:hover {
   color: var(--vp-c-brand-1);
 }
 
 .gitbookimg {
   margin: 3rem auto;
-}
+}
diff --git a/basic/how-to-start.md b/basic/how-to-start.md
@@ -4,8 +4,6 @@ description: 手把手教你搭建直播间
 
 # 🚀 如何 3 步开始直播
 
-
-
 * 新手开始直播，如何搭建一个精致的直播间，吸引更多的人气？
 * 很多人告诉你用 OBS直播，但是OBS的繁琐操作很让人头疼？
 * 还在为找不到合适的直播素材和模版而烦恼？
@@ -17,15 +15,15 @@ description: 手把手教你搭建直播间
 
 第一步：进入首页，选择模版。有横屏和竖屏的模版可供选择，根据你想要的直播场景和直播平台选择
 
-<img src="../public/.gitbook/assets/image (4).png" alt="">
+<img src="../public/.gitbook/assets/image (4) (1).png" alt="">
 
 第二步：进入编辑器，调整画面成最佳效果。图片、文字、素材都是可以更改的哦，背景和素材支持上传，还可以上传gif动图哦
 
-<img src="../public/.gitbook/assets/image (5).png" alt="">
+<img src="../public/.gitbook/assets/image (5) (1).png" alt="">
 
-<img src="../public/.gitbook/assets/image (6).png" alt="">
+<img src="../public/.gitbook/assets/image (6) (1).png" alt="">
 
 第三步：点击「开始直播」，填写推流码，推流码获取方式 [https://docs.lusun.com/live/basic/streamlink.html](https://docs.lusun.com/live/basic/streamlink.html)
 
-<img src="../public/.gitbook/assets/image (7).png" alt="">
+<img src="../public/.gitbook/assets/image (7) (1).png" alt="">
 
diff --git a/basic/introduction.md b/basic/introduction.md
@@ -0,0 +1,66 @@
+---
+description: 芦笋直播助手是什么？怎么用？
+---
+
+# 😃 芦笋直播助手介绍
+
+经常有新朋友问芦笋直播助手是什么？怎么用？今天就给大家正式介绍一下👇
+
+### 行业背景 {#bg}
+
+如何开始直播？很多人往往会告诉你用 OBS，配合各种硬件灯光，给你讲各种图层如何叠加，怎么用绿幕甚至虚拟绿幕，然后如何设置过滤器把绿幕去掉，变成透明效果… 内容丰富到，够你看一本教科书的。
+
+整个过程操作难，成本高，很多人被复杂的操作吓到了，干脆不学了。
+
+<img src="../public/.gitbook/assets/screenshot-20240802-202121.png" alt="">
+
+其实，你直播的目的主要是获取流量，不要给自己平白无故设置这么陡峭的学习曲线，你可以直接使用[芦笋直播助手](https://live.lusun.com/)。
+
+**芦笋直播助手是一款简单的直播工具，使命是能够让大家更简单快捷的开播，非常适合新手。**
+
+### 产品定位 {#location}
+
+**如果说OBS是直播领域的Photoshop，那芦笋直播助手希望做直播界的美图秀秀**
+
+让每一个人都不用经历陡峭的工具学习曲线，0门槛开始直播。
+
+<img src="../public/.gitbook/assets/image (7).png" alt="">
+
+### 产品特性 {#feature}
+
+1. **使用模版，轻松上手** 不再头疼找素材，直播模版在线更换，丰富素材在线使用，新手也能 3 步搭建精致直播间
+2. **录制直播，同时搞定** 让你录课不再麻烦，丰富录课模版，直接开录；边直播边录制，方便直播复盘
+3. **多平台直播，效率翻倍** 支持抖音、视频号和小红书等多平台同步直播，让你的直播效率和效果翻倍提升（开发中）
+
+<img src="../public/.gitbook/assets/feature_2.png" alt="">
+
+### 功能详述 {#details}
+
+1. 打开 [https://live.lusun.com/download/](https://live.lusun.com/download/?)下载软件，目前支持Windows和Mac双端，根据自己的电脑型号下载对应的安装包
+2. 打开软件，可以看到首页有横屏和竖屏的模版，点击「使用模版」或者「创建直播」
+
+<img src="../public/.gitbook/assets/image (6).png" alt="">
+
+3. 接下来就正式进入编辑器了，你可以设置合适的背景和画面
+4. 点击摄像头，可以选择圆形或者方形的摄像头，还可以进行绿幕抠像。注意：抠像必须配合绿幕才能生效，没有绿幕抠像不会成功
+
+<img src="../public/.gitbook/assets/image (1).png" alt="">
+
+5. 选择合适的背景，可以在推荐背景中进行选择，也可以自己上传
+
+<img src="../public/.gitbook/assets/image (2).png" alt="">
+
+6. 编辑文字，点击文字或者下方的元素区域，可以编辑内容、更改颜色，拖动文字右上角可以改变文字大小
+
+<img src="../public/.gitbook/assets/image (3).png" alt="">
+
+7. 芦笋直播助手不仅可以直播，还可以录制，并且支持在直播过程中录制，最高清晰度支持2k。
+
+<img src="../public/.gitbook/assets/image (4).png" alt="">
+
+8. 点击开播，有3种开播方法：
+   1. 快捷开播：你只需要登录B站或者视频号账号，我们可以直接抓取到推流码，不用每次直播都填写
+   2. 填写推流码开播：请参考[https://docs.lusun.com/live/basic/streaming-code.html](https://docs.lusun.com/live/basic/streaming-code.html)
+   3. 测试开播：可以直接开播，扫码预览直播效果，5分钟后直播会自动结束。
+
+<img src="../public/.gitbook/assets/image (5).png" alt="">
diff --git a/basic/streaming-code.md b/basic/streaming-code.md
@@ -4,47 +4,47 @@ description: 各直播平台推流码是怎么获取的？本文介绍获取推
 
 # 🔐 如何获取推流码
 
-### 视频号
+### 视频号 {#shipinhao}
 
 1. 推流到视频号需要获取推流地址和推流密钥。而视频号的直播推流能力（包含推流地址、推流密钥等）需要先完成视频号认证后才能够获取；
 2. 视频号认证路径：微信——发现——视频号——右上角个人中心——我的视频号——我的视频号详情页——更多设置——认证。
 3. 通过视频号认证后，登录视频号助手后台 [https://channels.weixin.qq.com/login](https://channels.weixin.qq.com/login) 。点击【直播管理】创建直播，创建直播后，即可进行直播配置，获取推流地址与密钥。
 4. 将推流地址与密钥填写到弹窗中，点击推流，可在视频号后台查看是否推流成功。推流成功即可显示画面，推流到微信视频号不会改变直播布局。
 
-<img src="../public/.gitbook/assets/image.png" alt="">
+<img src="../public/.gitbook/assets/image (9).png" alt="">
 
-### Bilibili
+### Bilibili {#bilibili}
 
 1. 登录哔哩哔哩[https://www.bilibili.com/](https://www.bilibili.com/) 点击自己的头像，进入到个人直播中心。
 2. 左边导航点击【我的直播间-开播设置】，进入自己的直播房间。设置直播房间标题与分类，点击开始直播按钮后展示推流地址。
 3. 将推流地址与密钥填写到弹窗中，点击推流，可在Bilibili直播间查看是否推流成功。推流成功即可显示画面，推流不会改变直播布局。
 
-<img src="../public/.gitbook/assets/image (1).png" alt="">
+<img src="../public/.gitbook/assets/image (1) (1).png" alt="">
 
-### 小红书
+### 小红书 {#xiaohongshu}
 
 * 下载小红书 App，实名认证后，打开预直播页面，切换到 「电脑」 tab，获取6位验证码
 <ImgCenter><img src="../public/.gitbook/assets/image (10).png" alt=""></ImgCenter>
 
 * 打开小红书官网中相关链接：[https://www.xiaohongshu.com/zhibo/robs](https://www.xiaohongshu.com/zhibo/robs)
 * 登录小红书账号，点击**「去 OBS 开播」**，然后输入上一步复制的 6 位数字，可以获取串流秘钥，复制这段密钥。
 
-<img src="../public/.gitbook/assets/image (8).png" alt="">
+<img src="../public/.gitbook/assets/image (8) (1).png" alt="">
 
-<img src="../public/.gitbook/assets/image (9).png" alt="">
+<img src="../public/.gitbook/assets/image (9) (1).png" alt="">
 
 注意事项：
 
 * 首次使用小红书直播时，建议先试播一次；
 * 一定要先在芦笋直播助手点「开始直播」，再在小红书里点「开始直播」；
 * 手机端生成的 6 位数字验证码具有时效性，生成后请在 12 小时内利用数字验证码在「小红书电脑直播教程」 页面获取串流秘钥；
 
-### 快手
+### 快手 {#kuaishou}
 
 1. 登录快手直播开放平台 [https://studio.kuaishou.com/user/login?redirect=%2F](https://studio.kuaishou.com/user/login?redirect=%2F)
 2. 创建直播-进入直播详情页，即可获取推流地址。
 3. 将推流地址与密钥填写到弹窗中，点击推流，推流成功即可显示画面，推流不会改变直播布局。
 
-<img src="../public/.gitbook/assets/image (3).png" alt="">
+<img src="../public/.gitbook/assets/image (3) (1).png" alt="">
 
 目前抖音、淘宝直播、西瓜视频不对外提供推流地址，可尝试向平台申请。