README

您可以将此包用作新Automad主题的包骨架。它包含所有文件，以快速开始您的主题。但是，只有一个简单的树形菜单模板文件。虽然其功能减少到最小，但它涵盖了Automad 模板语言的许多方面。使用美丽的Bulma CSS 框架来样式化模板，因此此包不包括任何 CSS 或 JS 文件。

• 包含的模板
• 开发流程
  • 本地包
  • 创建 Git 仓库
  • 注册您的包
• 速查表

包含的模板

此包包含这些简化模板，仅供演示目的

1. page.php 模板表示一个带有导航栏、内容区域和带菜单侧边的侧边栏的基本页面。
2. pagelist.php 模板包含一个可筛选和可排序的页面列表，可以用作博客或作品集的骨架。
3. session.php 模板演示了使用会话变量和 set 函数的方法。
4. images.php 模板提供了一个构建相册模板的最小示例。

☝️ 在玩弄模板时，只需将它们应用到您安装中的任何页面即可查看其效果！

开发流程

此非常详细的深入指南逐步描述了使用 Composer 设置和发布新主题的工作流程。如果您以前已经使用过 Composer，则可能可以跳过一些点。

☝️ 此指南假设您熟悉 Visual Code Studio 并在具有 Bash shell 或类似环境的系统上工作——如 macOS 或 Linux。当然，在 Windows PC 上也可以做同样的事情——只是略有不同。

本地包

1. 将新包开发在 Automad 包目录之外是一个好习惯。因此，切换到 Automad 之外的某个目录，您想在其中开发新主题。让我们假设您想将您的包放在家目录中名为 dev 的目录中。

   cd ~/dev
   

2. 使用 Composer 在您的 dev 目录中创建新的骨架主题。

   composer create-project automad/theme-skeleton my-theme
   

3. 切换到新主题目录，并编辑 composer.json 和 theme.json 文件。这里使用 VS Code 作为编辑器。至少更改供应商和主题名称。

   cd my-theme
   code composer.json
   

   还要编辑 theme.json 中的名称。

   code theme.json
   

4. 现在切换到您的 Automad 根目录。例如 ~/Sites/automad-site。

   cd ~/Sites/automad-site
   

5. 编辑 Automad 安装的 composer.json 文件。

   code composer.json
   

   将以下片段添加到 Automad 的 composer 文件中（注意包的路径）。

   {
       ...	
       "repositories": [
           {
               "type": "path",
               "url": "~/dev/my-theme"
           }
       ],
       ...
   }
   

6. 仍在 Automad 目录中，运行以下 Composer 命令。

   composer require my-vendor/my-theme:@dev
   

   现在您的主题在 Automad 中可用，您可以开始开发您的模板。在所有设置完成后，现在是为您的主题创建仓库的时候了。

创建 Git 仓库

开发完成后，就是发布您作品的时候了。

1. 初始化新的Git仓库并提交文件。

   cd ~/dev/my-theme
   git init
   git add .
   git commit -m "First commit"
   

2. 根据语义化版本控制方案，为您的成品主题创建一个初始版本标签。

   git tag -a 1.0.0 -m "my version 1.0.0"
   

3. 在GitHub上创建一个新的仓库。

4. 现在，将其URL添加为本地仓库的远程仓库，并推送更改。在创建仓库时，URL将打印在GitHub页面上。

   git remote add origin /remote/URL/of/your/new/repo
   git push -u origin master
   

注册您的包

现在，是时候将您的主题包提交到Packagist了。注册成功后，它将自动显示在包浏览器中。

速查表

如果您更喜欢在不阅读完整文档的情况下开始开发主题或扩展，那么速查表是一个不错的起点。