跳到主要内容

新文档

重要

强烈建议在添加新文档之前查看其他现有文件的源代码。这使您可以熟悉约定并确保新文件符合标准。但是，在此之前，我们要求您首先通过提出问题与我们协商。

概述​

我们使用 Docusaurus 编写文档。该工具使用扩展的 Markdown 格式 (MDX)。它是 Markdown 和 JSX 的组合，允许我们用 React 编写自定义组件。我们使用组件库来扩展文档中可以放入的内容的功能。借助 MDX，我们可以创建比典型网站更具交互性和吸引力的文档。

提示

访问此链接以了解如何在 Docusaurus 中创建文档。

指南​

根据您要编写的文档类型，文档内容必须遵循某些准则。

假设您想编写一节关于类构造函数（在课程中）的课程。

首先，您必须创建文档的英文版本，即使您想用其他语言编写。这是因为它是我们的备用语言，因此所有未提供某些文档翻译的区域都将回退到英文版本。选择一个不带空格、用连字符分隔的小写名称，例如

class-constructors.mdx

由于我们已经有了一个 classes 目录，我们可以跳过 class- 前缀，最终得到

classes/constructors.mdx

文档元数据​

您必须填写文档的元数据。打开它，并在最顶部创建一个文档元数据部分。

---
sidebar_label:		"1. Class constructors"
title:				"Class constructors"
description:		"Lesson: basics of class constructors in C++ language"
tags:				[class, constructor, method, object, object-oriented-programming, object-oriented, oop]
hide_title:			true
---
旧字段

sidebar_position 字段曾经是强制性的，但现在不使用了。请随意从仍包含它的文档中删除它。现在，位置严格通过 /sidebars/<section>.js 文件中的顺序管理。

危险

hide_title: true 仅在元数据和 Markdown H1 标题之间有内容时才应使用，例如

---
...
hide_title:			true
---

{/* Components */}
import Columns			from "@site-comps/Columns";

{/* Presets */}
import NotFinished		from "@site/i18n/en/presetsNotFinished";

# The title of the document

如果元数据直接位于 # 文档标题上方，请勿使用它，因为 Docusaurus 将生成一个额外的 H1 标题。

有关完整的元数据列表，请访问此页面。

添加到侧边栏​

您的文档最初不会显示在侧边栏中。导航到 /sidebars 目录，找到相应的文件（学习部分的 learn.js，工具部分的 tools.js 等），然后将 constructors 添加到列表中。

侧边栏使用 JavaScript 配置，但它们的大部分配置都是通过简单的数组和对象完成的，因此即使您不懂该语言，也易于使用。我们创建的文档应按如下方式添加到侧边栏中

// ...
{
	type: 'category',
	label: '9. Classes',
	items: [
		'course/intermediate/classes/intro',
		'course/intermediate/classes/constructors',
		'course/intermediate/classes/destructors',
		// ...
	]
}

添加内容​

注意

请阅读我们的一般编辑规则和提示

模板​

目前我们还没有文档模板。未来我们会创建它们，一旦我们建立某种标准。

我们有一些好的文档示例，您应该访问它们并可能将它们用作临时模板

文档

学习

新文档

重要

强烈建议在添加新文档之前查看其他现有文件的源代码。这使您可以熟悉约定并确保新文件符合标准。但是，在此之前，我们要求您首先通过提出问题与我们协商。

概述​

我们使用 Docusaurus 编写文档。该工具使用扩展的 Markdown 格式 (MDX)。它是 Markdown 和 JSX 的组合，允许我们用 React 编写自定义组件。我们使用组件库来扩展文档中可以放入的内容的功能。借助 MDX，我们可以创建比典型网站更具交互性和吸引力的文档。

提示

访问此链接以了解如何在 Docusaurus 中创建文档。

指南​

根据您要编写的文档类型，文档内容必须遵循某些准则。

假设您想编写一节关于类构造函数（在课程中）的课程。

首先，您必须创建文档的英文版本，即使您想用其他语言编写。这是因为它是我们的备用语言，因此所有未提供某些文档翻译的区域都将回退到英文版本。选择一个不带空格、用连字符分隔的小写名称，例如

class-constructors.mdx

由于我们已经有了一个 classes 目录，我们可以跳过 class- 前缀，最终得到

classes/constructors.mdx

文档元数据​

您必须填写文档的元数据。打开它，并在最顶部创建一个文档元数据部分。

---
sidebar_label:		"1. Class constructors"
title:				"Class constructors"
description:		"Lesson: basics of class constructors in C++ language"
tags:				[class, constructor, method, object, object-oriented-programming, object-oriented, oop]
hide_title:			true
---
旧字段

sidebar_position 字段曾经是强制性的，但现在不使用了。请随意从仍包含它的文档中删除它。现在，位置严格通过 /sidebars/<section>.js 文件中的顺序管理。

危险

hide_title: true 仅在元数据和 Markdown H1 标题之间有内容时才应使用，例如

---
...
hide_title:			true
---

{/* Components */}
import Columns			from "@site-comps/Columns";

{/* Presets */}
import NotFinished		from "@site/i18n/en/presetsNotFinished";

# The title of the document

如果元数据直接位于 # 文档标题上方，请勿使用它，因为 Docusaurus 将生成一个额外的 H1 标题。

有关完整的元数据列表，请访问此页面。

添加到侧边栏​

您的文档最初不会显示在侧边栏中。导航到 /sidebars 目录，找到相应的文件（学习部分的 learn.js，工具部分的 tools.js 等），然后将 constructors 添加到列表中。

侧边栏使用 JavaScript 配置，但它们的大部分配置都是通过简单的数组和对象完成的，因此即使您不懂该语言，也易于使用。我们创建的文档应按如下方式添加到侧边栏中

// ...
{
	type: 'category',
	label: '9. Classes',
	items: [
		'course/intermediate/classes/intro',
		'course/intermediate/classes/constructors',
		'course/intermediate/classes/destructors',
		// ...
	]
}

添加内容​

注意

请阅读我们的一般编辑规则和提示

模板​

目前我们还没有文档模板。未来我们会创建它们，一旦我们建立某种标准。

我们有一些好的文档示例，您应该访问它们并可能将它们用作临时模板

文档

学习