Jellyfin.org 项目启动与配置教程

Jellyfin.org 项目启动与配置教程

jellyfin.org The Jellyfin website, blog, and user documentation 项目地址: https://gitcode.com/gh_mirrors/je/jellyfin.org

1. 项目的目录结构及介绍

Jellyfin.org 是 Jellyfin 项目的官方网站，包含了网站、博客和用户文档。项目的目录结构如下：

• /.github：包含 GitHub Actions 相关的配置文件。
• /blog：存放博客相关的内容和配置。
• /docs：存放用户文档的源文件。
• /scripts：包含项目构建和部署的脚本文件。
• /src：项目的源代码目录，包括网站的前端代码。
• /static：存放静态资源，如图片、样式表等。
• /README.md：项目的说明文档。
• /package.json：项目的 npm 配置文件。
• /tsconfig.json：TypeScript 配置文件。
• 其他配置和忽略文件，如 .eslintrc.json、.prettierrc 等。

每个目录下的文件都是该项目的重要组成部分，用于构建和运行 Jellyfin 的官方网站。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 中的脚本实现。以下是主要的启动文件和命令：

• package.json：在这个文件中，定义了 scripts 部分，其中包括了启动开发服务器的命令 start。

"scripts": {
  "start": "docusaurus-start",
  // 其他脚本命令...
}

要启动本地开发服务器，你需要在项目根目录下运行以下命令：

npm start

这条命令将启动 Docusaurus 开发服务器，并且通常会自动打开浏览器窗口，展示网站内容。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• docusaurus.config.js：这是 Docusaurus 的主配置文件，用于定义网站的基本信息和插件。

module.exports = {
  // 网站元数据...
  plugins: [
    // 插件列表...
  ],
  // 其他配置...
};

• tsconfig.json：TypeScript 配置文件，用于指定 TypeScript 编译器的选项。

{
  "compilerOptions": {
    // 编译器选项...
  },
  // 包含和排除文件...
}

• .eslintrc.json：ESLint 配置文件，用于定义代码质量和风格规则。

{
  "extends": ["eslint:recommended"],
  "rules": {
    // 规则定义...
  }
}

• 其他配置文件，如 .prettierrc、.markdownlint.yaml 等，分别用于配置 Prettier 和 Markdown Lint 的规则。

确保在开始之前，你已经安装了所有必要的依赖项：

npm install

然后根据需要修改配置文件，以适应你的项目需求。

jellyfin.org The Jellyfin website, blog, and user documentation 项目地址: https://gitcode.com/gh_mirrors/je/jellyfin.org