首页
/ Ember.js Guides 文档编写指南

Ember.js Guides 文档编写指南

2024-09-22 13:32:03作者:伍霜盼Ellen

开源项目 Ember.js Guides 的文档编写指南旨在帮助新贡献者了解项目结构和文档的构建过程,并指导他们如何参与贡献。

项目的目录结构及介绍

Ember.js Guides 的代码仓库 guides-source 包含了 Ember.js 指南的所有文本内容。以下是项目的主要目录结构:

/guides-source
├── /guides        # 指南内容的主要目录
│   └── /release    # Ember.js 最新版本的指南内容
├── /node-tests    # 包含测试脚本,用于验证链接和内容的正确性
├── /public        # 包含静态资源,如图片和 CSS 文件
├── /scripts       # 包含构建和部署脚本
├── /testem        # 包含测试配置文件
├── CONTRIBUTING.md # 贡献指南
├── LICENSE        # 许可协议文件
├── MAINTAINERS.md # 维护者信息
└── README.md      # 项目简介

每个 Ember.js 版本都有自己的目录,例如 /guides/v3.5/guides/release 目录包含最新的 Ember.js 版本的指南内容。

项目的启动文件介绍

项目使用 ember serve 命令启动本地服务器。这个命令会将 Markdown 文件转换为 HTML,并在本地浏览器中打开它们。这允许你在本地预览指南内容,并进行编辑和测试。

项目的配置文件介绍

项目包含多个配置文件,用于管理文档的构建和部署过程。以下是一些主要的配置文件:

  • ember-cli-build.js:这是 Ember.js 应用程序的构建配置文件。它定义了应用程序的入口文件、依赖关系和其他构建设置。
  • .eslintrc.js:这是 ESLint 的配置文件。它定义了代码风格规则和语法检查规则,以确保代码质量。
  • package.json:这是项目的元数据文件。它包含了项目的名称、版本、依赖关系和其他配置信息。
  • README.md:这是项目的简介文件。它提供了项目的概述、安装说明和贡献指南。
热门项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
263
54
国产编程语言蓝皮书国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区
65
17
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
85
63
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
53
44
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
196
45
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
268
69
xxl-jobxxl-job
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
Java
9
0
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
171
41
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
38
24
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
332
27