Skip to main content

Building Themes

建立和运行用于构建主题的工作空间的最快方法是使用官方的gatsby-starter-theme-workspace启动器.

视频托管在egghead.io.

首先,运行:

这将为您生成一个新项目. 文件树将如下所示:

纱线工作区是设置主题开发项目的好方法,因为它们支持在单个父目录中容纳多个包并将它们链接在一起.

对于Gatsby主题开发,这意味着您可以将多个主题和示例站点放在一个项目中,然后在本地进行开发.

如果愿意,可以将主题开发为本地插件 . 使用yarn linknpm link也是可行的选择. 总体而言,盖茨比建议使用纱线工作区方法构建主题,这就是入门者和本指南将反映的内容.

入门人员负责使用纱线工作区开发主题的所有配置. 如果您对这种设置的详细信息感兴趣,请查看此博客文章 .

package.json

新项目根目录中的package.json主要负责设置纱线工作区. 在这种情况下,有两个工作区,即gatsby-theme-minimalexample .

/gatsby-theme-minimal

/gatsby-theme-minimal目录是您将要开发的新主题的起点.

在其中,您会发现:

  • gatsby-config.js :一个空的gatsby-config,可以用作将功能构建到主题中的起点.
  • index.js :由于主题也可以用作插件,因此这是Gatsby要将其用作插件所需的空文件.
  • package.json :一个文件,列出了人们安装主题时主题将拉入的依赖项. Gatsby应该是一个对等依赖项.

/example

/example目录是Gatsby网站的示例,该网站安装并使用本地主题gatsby-theme-minimal .

在其中,您会发现:

  • gatsby-config.js :指定要使用的主题以及网站可能需要的其他一次性配置.
  • /src :包含源代码,例如可能驻留在用户站点中的自定义页面或组件.

Publishing a Theme

构建主题之后,您可能希望将其发布给Gatsby社区. 为此,请将主题插件发布到插件库 .

Further resources

Gatsby Theme Authoring (Video course)

观看有关"创作盖茨比主题"的新Egghead课程 .

Building a Gatsby Theme (Tutorial)

查看有关构建Gatsby主题教程 . 分步教程比本文档指南更详细. 它是作为Egghead主题创作课程的伴侣编写的 ,因此可以一起使用!

Theme API reference

查看主题API文档 .

Accessibility

Gatsby主题是Gatsby站点,因此在考虑可访问性时进行构建至关重要. 查看有关使您的网站(和主题!)可访问性的这些提示 .

Read through source code

查看如何构建一些现有主题:


Edit this page on GitHub
Docs
Tutorials
Plugins
Blog
Showcase

by  ICOPY.SITE