冬季/wn-nabu-theme

为文档网站设计的优雅主题。

资助包维护!
wintercms
Open Collective

安装: 438

依赖项: 0

建议者: 0

安全性: 0

星级: 6

关注者: 4

分支: 3

开放问题: 0

语言:JavaScript

类型:winter-theme

v1.1.1 2024-07-23 12:27 UTC

This package is auto-updated.

Last update: 2024-09-03 06:35:58 UTC


README

Nabu logo

为文档网站设计的优雅主题,利用Winter CMS的强大功能DocsSearch插件,提供流畅的文档浏览体验。

要求

功能

  • 完全集成Docs和Search插件功能,用于导航和显示多个文档实例。
  • 支持用户和开发人员的Markdown文档,以及从PHP项目生成的API文档。
  • 根据操作系统主题显示浅色或深色主题,但用户可以覆盖。
  • 完全使用Tailwind构建,允许对网站的外观和感觉进行完全灵活的调整。
  • AJAX驱动的导航和客户端缓存确保文档加载快速,并且可以更快地进行导航。

开发

此主题已使用Tailwind进行样式设计,并使用Snowboard进行JavaScript功能,利用Winter CMS中包含的Mix资源编译功能。要编译主题,只需安装Mix所需的库

php artisan mix:install

然后,您可以编译主题以用于生产

php artisan mix:compile --production -p theme-nabu

您还可以设置主题以监视更改,每次样式表或模板发生更改时重新编译主题

php artisan mix:watch --production theme-nabu

默认情况下,此主题已设置不将编译后的资源包含在源代码控制中,因为建议将上述编译过程包含在构建或部署脚本中。但是,如果您希望将编译后的资源包含在源代码控制中,您可以从.gitignore定义中删除以下部分

# Ignore compiled assets
assets/css/theme.css
assets/js/build/app.js