首页
/ 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:这是项目的简介文件。它提供了项目的概述、安装说明和贡献指南。
热门项目推荐

项目优选

收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
10
4
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K