README

José Manuel Rosado Hurtado 2023 - ejerciciosmesa.com

描述

DOCMA 是一个使用 Markdown 格式的文本创建的文档浏览器。它允许使用此类文档快速创建交互式文档。由于自动创建索引，文档的导航变得容易，主题的访问快速直观。另一方面，使用 DOCMA 创建的文档可以发布到服务器，以便所有需要查阅的人都可以访问。

创建文档项目

要在控制台创建文档项目，请执行以下命令

composer create-project nepenteh/docma

这将在 docma 文件夹中创建一个文件夹，并在其中需要注意以下元素

文件夹：/public/Contents

此文件夹将包含您要显示的文档的不同 Markdown 文件。例如，项目安装中包含关于太阳系的文档。这些文件应被删除并替换为您自己的文件。

文件 .env

此文件包含三个可配置的数据：文档标题、包含内容的文件夹名称和文档的自定义样式 CSS 文件。

• 文档标题。 请写下您想为其文档指定的标题。此标题将显示在屏幕顶部。
• 内容文件夹名称。 请写下您想要为其文档内容文件夹指定的名称。默认为 Contents。请注意，如果更改此名称，则必须更改位于 /public 文件夹中的 Contents 文件夹的名称。
• 文档自定义样式 CSS 文件名称。 此 CSS 文件位于 /public/css 文件夹中，可以自定义以更改文档的样式。请在此处指定要分配给该文件的名称，并确保它在 /public/css 文件夹中存在。

使用 Docma 创建文档的过程

创建包含内容的文件。

请按照此标记语言规则在文件中编写每个主题。这些文件必须以主题编号和部分编号（由破折号分隔）开始的名称命名。以下是对 Docma 文件命名的示例

以下是符合 Docma 规范命名的文件示例

• 01-00_Europa.md
• 01-01_España.md
• 01-02_Italia.md
• 01-03_Francia.md
• 01-04_Alemania.md
• 02-00_Africa.md
• 02-01_Nigeria.md
• 02-02_Camerún.md
• 02-03_Marruecos.md
• 03_00_Asia.md
• 03_01_China.md
• 03_02_India.md

这些文件定义了三个主要主题：欧洲、非洲和亚洲，每个主题内部有不同部分，对应于每个大洲的各个国家。如果命名正确，Docma 视图器将能够在屏幕左侧自动创建索引，其中包含主题和部分，以及每个主题末尾的导航按钮，允许跳转到下一个或上一个主题。

所有以这种方式创建的 markdown 文件都必须位于一个可以随意命名的文件夹内，并且该文件夹必须位于 /public 文件夹内。默认情况下，这个文件夹是 /public/Contents 文件夹。

文档中的图片和其他元素

Contents 文件夹还可以包含一个名为 imagenes 的子文件夹，用于存储文档中使用的图片（或用户希望的其他内容的文件夹）。如果您想指定文档中 imagenes 子文件夹中某个图片的路径，请使用 'Contents/imagenes/fichero_de_imagen.extension'，以确保正确的访问。（您可以查阅项目内包含的示例 markdown 文件）

文档中其他主题的链接

通过使用带有 cnt 参数的 index.php 并将主题编号分配给该参数来访问特定主题。例如，如果您想在文档的 markdown 文件中创建一个指向编号为 01_04 的“德国”主题的链接，您需要指示以下内容

[Alemania](index.php?cnt=01_04)

CSS 样式

Docma 项目文件夹包含一个名为 visordoc.css 的 CSS 文件，该文件位于 /public/css 文件夹内。该文件定义了查看器的基本样式，不应进行修改。然而，您可以在该文件夹内添加另一个 CSS 文件，以定义文档的个性化样式。添加此新 CSS 文件，并确保在 .env 环境变量配置文件中指定此文件的名称。

太阳系示例文档

该项目包含一个关于太阳系的示例文档。该示例中的示例信息已从维基百科提取。此外，还包括一个名为 planetas.css 的文件，它为该文档定义了特定的样式。

示例 markdown 文件和 css 文件都应由用户创建的文档替换。

您可以通过以下链接访问使用 Docma 发布的文档示例

DUENDE 代码生成器文档