README

您可以将此包用作新 Automad 主题的包骨架。它包含所有文件，以便您快速开始自己的主题。然而，只有一个简单的模板文件，带有简单的树形菜单。虽然其功能被降到最低，但它涵盖了关于 Automad 模板语言的主题开发的大部分方面。使用美丽的 Bulma CSS 框架来样式化模板，因此此包不包含任何 CSS 或 JS 文件。

包含的模板
开发流程
速查表

包含的模板

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

page.php 模板代表一个带有导航栏、内容区域和带有菜单的侧边的页面。
pagelist.php 模板包含一个可过滤和排序的页面列表，可以用作博客或组合的骨架。
session.php 模板演示了会话变量和 set 函数的用法。
images.php 模板提供了一个如何构建相册模板的最小示例。

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

开发流程

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

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

本地包

一个好的做法是在 Automad 包夹目录之外开始开发新包。因此，将目录更改为 Automad 之外您想要开发新主题的某个目录。假设您想在主目录中的 dev 目录中放置您的包。
```
cd ~/dev
```
使用 Composer 在您的 dev 目录中创建新的骨架主题。
```
composer create-project automad/theme-skeleton my-theme
```
切换到新的主题目录并编辑 composer.json 和 theme.json 文件。这里使用 VS Code 作为编辑器。至少更改供应商和主题名称。
```
cd my-theme
code composer.json
```
还要编辑 theme.json 中的名称。
```
code theme.json
```
现在切换到您的 Automad 根目录。例如 ~/Sites/automad-site。
```
cd ~/Sites/automad-site
```

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

code composer.json

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

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

仍然在 Automad 目录中运行以下 Composer 命令。
```
composer require my-vendor/my-theme:@dev
```
现在，您的主题在 Automad 中可用，您可以从开发模板开始。完成所有设置后，现在是时候为您的主题创建一个仓库了。

创建 Git 仓库

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

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

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

根据语义版本控制方案为您完成的主题创建第一个版本标签。
```
git tag -a 1.0.0 -m "my version 1.0.0"
```
在 GitHub 上创建新的仓库。
现在，将其 URL 添加为本地仓库的远程，并推送更改。在创建仓库时，URL 将打印在 GitHub 页面上。
```
git remote add origin /remote/URL/of/your/new/repo
git push -u origin master
```

注册您的包

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

速查表

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

7r5n / moviate-theme

维护者

详情

README

包含的模板

开发流程

本地包

创建 Git 仓库

注册您的包

速查表