简介
在前端开发中，我们通常需要编写和更新文档，以便其他开发人员和用户能够理解我们的工作并使用我们的产品。@1nd/documentation 是一个 NPM 包，它提供了一种轻松实现可读性高并且易于维护的文档页面的方法，减少了额外的工作量，提高了开发效率。
安装
使用 npm 安装 @1nd/documentation：
--- ------- -- ------------------
用法
Step 1：创建文档文件
首先，我们需要在应用程序根目录中创建一个 docs 文件夹，用于存储我们的文档。
在 docs 文件夹中，创建一个名为 README.md 的文件。这将是你的文档页面的入口文件。
Step 2：编辑文档页面
在 README.md 文件中，您可以添加标题，段落，列表，代码块等等。同样，您可以使用 Markdown 语法为您的页面添加样式和格式。
您可以在文件的顶部添加 YAML 头文件数据（如下所示），以添加您的页面的标题和描述。
--- ------ -- ------------- ---- ------------ ---- -- - ------------- ---- --- --- -------------- ---
您还可以使用嵌入式 HTML 标签为您的文档添加样式，例如：
---- ------------------ --- ------------------------ ----------- -- ----------------- -- - ------ ---- ----- - ------ --------------- --------- --- ------- ----- --------- -- -------- ------- -- ---------------- --- ------------- ----- ---- ------- ------- --- ---------- --- ------- -- ----- ------- --- ------ --- ------ -------------- -- ---------- ----------- ------- -------- ------------------- -------- ------
Step 3：启动带有文档页面的本地服务器
使用以下命令在本地计算机上启动一个本地服务器，以便您可以在浏览器中预览和编辑文档页面：
--- ------------- -----
Step 4：发布文档页面
使用以下命令将文档页面发布到 GitHub Pages：
--- ------------- ------- ------
现在，您可以访问以下 URL，查看您的文档页面：
----------------------------------------------
示例
以下是一个简单的示例文档页面，其中包含标题，段落，列表和代码块：
--- ------ -- ------ ------------- ---- --- - ------- -- -- ------ ------------- ---- ---- -- ---- ------ ---- -- --- --- ------ -- ------------ -- ------- --- -------------- --- --- --------- --------
npm install myapplication
-- ----- --- --- --------------- ----- -- ------ - --- -------- -- --- ------------ ------------- ----- ------------- - --- ----------------
The MyApplication class provides several methods for interacting with the application.
Enjoy!
-- -- -- ------------------------------------------------------------------------- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------