wpjscc/wn-nabu-theme

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

维护者

详情

github.com/wpjscc/wn-nabu-theme

主页

源代码

问题

安装: 31

依赖项: 1

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 3

语言:JavaScript

类型:winter-theme

dev-main 2023-02-26 04:28 UTC

Requires

MIT f03cc5b871e99ca6998cf7aceaefb67a2fe2d257

documentationthemedocsnabuwinterwinter cms

This package is auto-updated.

Last update: 2024-08-26 07:54:09 UTC

README

Nabu logo

一款专为文档网站设计的优雅主题，利用 Winter CMS 的强大功能插件 Docs 和 Search，提供流畅的文档浏览体验。

要求

  • Winter CMS v1.2 或以上版本，需要安装以下插件
    • Winter.Docs
    • Winter.Search
  • NodeJS v14.0 或以上
  • NPM v6.0 或以上

功能

  • 完全集成 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 -p theme-nabu

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

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