《Mathematica 激活指南》项目概述

欢迎！非常感谢您对本项目有兴趣。

在编辑前，请阅读以下介绍。

本文提供项目的基本信息。

编辑指导在《贡献指南》。详细的写作风格要求在《写作风格指南》。也可直接访问 docs 目录，探索其他指南。

当准备就绪后，请 fork 此 repo。如果已经持有老旧的 fork，不妨采用您习惯的方式更新。之后开始编辑。最后新建一个 pull request。

感谢您的支持。

编码风格

下述规则已写入 .editorconfig。 可以在 EditorConfig.org 了解该文件的有关知识。

未说明的项目暂不做要求。

• UTF-8 (without BOM)
• LF line ending
• 文档末尾有换行符
  • JSON 文档末尾可以没有换行符
• 缩进
  • 使用空格缩进
  • CSS、HTML、JavaScript、YAML 的缩进为 2 个空格

Markdown 代码风格

• 支持 CommonMark 0.29 语法
• 使用 GitHub 推荐的书写风格

摘要如下

注意

• 在多级列表中，子级的左端应当对齐父级的内容的左端。详见 CommonMark Spec 的 “5.2 List items” 的第 6 条。
• 磁力链接 (magnet) 请以 code block 呈现，以防编译错误。
• 请使用 <del> 添加删除线。不要使用 <strike>，因为该元素已经废除。
• 请不要触动 front matter，除非本项目的管理者 @TieBaMma 已经确认需要修改。
• 随着 GitHub Pages 上部署的 Jekyll 更新换代，可以使用的 Markdown 语法或许会有扩展。参看 Markdown processor for your GitHub Pages site。

写作风格

详细的写作风格要求在《写作风格指南》。

摘要如下

• 组织语言
  • 清晰准确，简洁明了，通俗易懂。
  • Top 10 tips for Microsoft style and voice | Microsoft Style Guide
  • 句子 | 中文技术文档的写作规范 | 阮一峰
• 标点符号
  • 夹注符号跟随内部：夹注符号内部的 script，决定夹注符号的 script。
  • 中文与西文之间、中文与数字之间留一个空格。
  • 连续的中文内、西文与中文标点（不包括夹注符号）之间没有空格，除非
    • 不加空格会导致编译错误。
    • 不加空格会导致无法区分专有名词和普通名词。
    • 特殊的排版规定。
• 文本格式
  • 使用粗体表示强调 (strong importance)，使内容醒目。
  • 在较长的句子、段落中，可以设置专有名词为粗体，专业术语为斜体。

常见的 Markdown 编辑器

尽管我们对编辑工具没有要求，您甚至可以直接使用 GitHub 网页内置的文本编辑器工作；但仍然建议使用功能丰富且正确支持 CommonMark 的编辑器以减少编辑错误。

尚无想法？不妨尝试这几款编辑器和插件。

• Visual Studio Code
  • Markdown All in One
  • markdownlint
  • Markdown Preview Enhanced
  • Code Spell Checker
  • EditorConfig for VS Code
• Atom
  • markdown-preview-enhanced （这一个插件能代替好几个）
  • editorconfig
  • 更多参考使用 Atom 打造 Markdown 编辑器 | Florian | 博客园
• ghostwriter
• Sublime Text
  • MarkdownEditing
  • MarkdownPreview
  • Editor​Config
  • 更多参考
    • Sublime Text 3 打造 Markdown 编辑器 | 杨柳岸小鹏残月
    • Sublime 插件：Markdown 篇 | Mintisan
• TextMate
  • markdown.tmbundle
  • GitHub-Markdown.tmbundle
  • EditorConfig TextMate PlugIn
• Notepad++
  • MarkdownViewerPlusPlus
  • Markdown Syntax Highlighting for Notepad++
  • EditorConfig Notepad++ Plugin
• Visual Studio
  • Markdown Editor

如何编辑下载地址列表

请阅读《贡献指南》。

目录结构

如果需要了解 Jekyll 文件的意义，请访问它的文档。

以下仅列出关键文件。

第三方

本项目使用 Jekyll，由 GitHub Pages 自动生成网站。

本项目使用 Jason Long 制作的 Cayman theme，基于 pietromenna/jekyll-cayman-theme@595426b，修改了部分样式。

本项目使用 Vladimir Jimenez 制作的 allejo/jekyll-toc@204bd5c 来生成 Table of Contents。