Ember-CLI-Showdown 使用手册

Ember-CLI-Showdown 使用手册

ember-cli-showdownEmber component to render markdown into HTML.项目地址:https://gitcode.com/gh_mirrors/em/ember-cli-showdown

项目目录结构及介绍

Ember-CLI-Showdown 是一个专为 Ember.js 应用设计的扩展，它基于 Showdown 库来将 Markdown 文本转换为 HTML，尤其适用于 Ember 的 Fastboot 和 Prember 环境。下面简要概述其关键目录和文件的意义：

• addon/: 包含所有自定义的 Ember 组件、混合体、辅助方法等，这些是扩展的核心功能部分。
• app/: 这里存放的是当该插件被安装到其他 Ember 应用中时，自动被合并到应用的默认代码。比如，任何组件或模板会被直接添加到应用中。
• tests/: 测试套件所在位置，确保插件的功能按预期工作。
• ember-cli-build.js: 构建配置文件，定义了如何编译项目以及使用哪些加载器或插件。
• testem.js: Test'em Scripts 配置文件，用于设置测试环境和执行方式。
• package.json: 项目元数据文件，包括依赖项、脚本命令和项目的描述等。
• LICENSE: 许可证说明，指示项目遵循的开放源代码许可协议，通常是 MIT 许可证。
• README.md: 项目的主要文档，提供快速入门指导和重要信息给开发者。

项目的启动文件介绍

主要关注点在于 ember-cli-build.js 文件。这个文件负责配置 Webpack 或 Broccoli 构建流程，定义了 Ember 应用的构建过程，包括加载必要的库、插件以及优化配置。当你想要调整构建过程，比如增加额外的处理步骤（例如预编译Markdown文件）时，你将会编辑此文件。

示例基础配置段落：

module.exports = function(defaults) {
  let app = new EmberApp(defaults, {
    // 添加自定义选项，例如：
    'ember-cli-showdown': {
      // 自定义配置项
    },
  });

  // 可以在这里加入其它的打包规则或者插件配置
  
  return app.toTree();
};

项目的配置文件介绍

对于 Ember-CLI-Showdown，核心配置通常不是直接在项目内部文件中进行的。它的配置更多地依赖于如何通过 Ember 的环境变量或在使用时传入参数的方式来进行定制。然而，间接配置可能涉及在你的应用的 environment.js 文件中调整 Ember-CLI-Showdown 特定的设置，如果该扩展提供了需要在应用级别上配置的选项的话。

假设配置示例（并不存在于标准库中，仅作为演示）

// config/environment.js
if (environment === 'development') {
  ENV['ember-cli-showdown'] = {
    showLineNumbers: true,
    additionalLanguages: ['typescript'],
  };
}

请注意，实际的配置细节需参考项目文档，因为上述配置示例是为了说明目的而假设的，并不直接来源于提供的GitHub仓库内容。在使用时，请查阅最新版本的README.md以获取确切的配置指令。

ember-cli-showdownEmber component to render markdown into HTML.项目地址:https://gitcode.com/gh_mirrors/em/ember-cli-showdown