RustDesk 文档项目教程

项目的目录结构及介绍

RustDesk 文档项目的目录结构如下：

doc.rustdesk.com/
├── _config.yml
├── _data
│   └── navigation.yml
├── _includes
│   ├── footer.html
│   ├── head.html
│   ├── header.html
│   └── sidebar.html
├── _layouts
│   ├── default.html
│   ├── home.html
│   └── page.html
├── _posts
│   └── 2023-01-01-welcome-to-rustdesk.md
├── _sass
│   ├── main.scss
│   └── _base.scss
├── assets
│   ├── css
│   │   └── main.scss
│   ├── images
│   └── js
├──Gemfile
├──Gemfile.lock
├── index.md
└── README.md

目录结构介绍

• _config.yml: Jekyll 配置文件，用于配置网站的基本信息和行为。
• _data/: 存放数据文件，例如 navigation.yml 用于定义导航栏。
• _includes/: 存放可重用的 HTML 片段，如页眉、页脚等。
• _layouts/: 存放页面布局模板，如默认布局、首页布局等。
• _posts/: 存放博客文章，文件名格式为 YYYY-MM-DD-title.md。
• _sass/: 存放 SASS 样式文件，用于生成 CSS。
• assets/: 存放静态资源，如 CSS、图片和 JavaScript 文件。
• Gemfile 和 Gemfile.lock: 定义项目所需的 Ruby 依赖。
• index.md: 首页内容。
• README.md: 项目说明文档。

项目的启动文件介绍

RustDesk 文档项目的启动文件是 index.md。这个文件是网站的首页内容，通常包含欢迎信息和项目简介。

index.md 内容示例

---
layout: home
title: 欢迎来到 RustDesk 文档
---

# 欢迎来到 RustDesk 文档

这里是 RustDesk 的官方文档站点，提供详细的使用指南和开发文档。

项目的配置文件介绍

RustDesk 文档项目的配置文件是 _config.yml。这个文件用于配置 Jekyll 站点的各种设置，包括网站标题、描述、URL 等。

_config.yml 内容示例

title: RustDesk 文档
email: [e-mail]
description: >-
  这里是 RustDesk 的官方文档站点，提供详细的使用指南和开发文档。
baseurl: ""
url: "https://doc.rustdesk.com"
twitter_username: rustdesk
github_username: rustdesk

# 导航栏配置
navigation:
  - title: 首页
    url: /
  - title: 文档
    url: /docs/
  - title: 博客
    url: /blog/

配置文件介绍

• title: 网站标题。
• email: 联系邮箱。
• description: 网站描述。
• baseurl: 网站的基本 URL。
• url: 网站的完整 URL。
• twitter_username 和 github_username: 社交媒体用户名。
• navigation: 导航栏配置，定义导航项的标题和链接。

以上是 RustDesk 文档项目的目录结构、启动文件和配置文件的详细介绍。希望这些信息能帮助你更好地理解和使用该项目。