dft/silverstripe-recipe

SilverStripe 全功能 CMS 的 '厨房水槽' 配方

安装: 4

依赖: 0

建议者: 0

安全: 0

星级: 1

观察者: 4

分支: 0

开放问题: 2

语言:SCSS

类型:silverstripe-recipe


README

包含我们常用所有模块的基本 SilverStripe 网站安装。

创建新项目

可以将配方引入任何现有项目(即使不是在 SilverStripe 基础项目上创建的)

SS5 版本

$ composer init
$ composer require dft/silverstripe-recipe:5.x-dev

SS4 版本(已弃用)

$ composer init
$ composer require dft/silverstripe-recipe:4.x-dev

或者,您可以根据现有配方创建新项目

SS5 版本

$ composer create-project dft/silverstripe-recipe ./myssproject 5.x-dev

SS4 版本(已弃用)

$ composer create-project dft/silverstripe-recipe ./myssproject 4.x-dev

内联配方

您可以“内联”之前已安装的配方,或者您想在主项目中包含依赖项的新配方。通过内联配方,您将其需求以及项目文件提升到主项目,并从依赖项中删除配方本身。

这可以通过 update-recipe 完成,它将更新配方,或者通过 require-recipe 安装新配方。

注意,如果您想运行此命令,您必须首先通过正常的 composer 命令安装配方,或者安装配方插件

$ composer init
$ composer require dft/silverstripe-recipe ^0.1
$ composer require-recipe dft/silverstripe-recipe ^1.0@dev

$ composer init
$ composer require dft/silverstripe-recipe ^1.0@dev
$ composer update-recipe dft/silverstripe-recipe

更多文档

更全面的文档可以在 recipe 插件 GitHub 页面 找到

主题

此配方安装了多个可能的基本主题,但还构建了一个“自定义”主题,可以用来覆盖默认选定的主题。

如果您想将默认的基本主题切换为替代方案,建议您将 theme.yml 中的 bootstrap 改为您的替代方案,例如

SilverStripe\View\SSViewer:
  themes:
    - 'custom'
    - 'deferedimages'
    - 'bootstrap' # Change this to your base theme
    - '$default'

Webpack

自定义主题(及其父主题)旨在使用 webpack 来帮助打包和管理 CSS 和 JS 需求。

或者,您也可以直接使用默认的 SilverStripe 方法(将您自己的文件添加到 dist/css 或 dist/js),但您将需要管理合并和压缩它们。

这可以通过 webpack 自动处理。

入门

要开始使用 webpack 来管理您的 JS 和 CSS 需求,首先您必须安装 yarn

安装 yarn 后,导航到您的主题目录

# cd /path/to/my/project/themes/custom

现在安装节点模块(可能需要一些时间)

# yarn install

添加自定义 CSS/JS

接下来,将您的自定义 JS 或 CSS (SASS) 添加到相应的文件夹(themes/custom/src/javascriptthemes/custom/src/scss 分别),如果您添加了任何新文件,您需要在以下位置导入它们

  • SCSS 文件添加到 themes/custom/src/scss/bundle.scss
  • JS 文件需要直接映射到 themes/custom/webpack.common.js

最后,运行以下命令之一来转换/压缩您的文件

  • yarn dev:转换所有文件以进行开发目的(不压缩)
  • yarn build:转换并压缩以进行生产
代码检查

包括了一些代码检查功能来帮助保持代码整洁。如果您想检查/整理 CSS/JS,可以运行以下命令

  • yarn lint:stylesyarn lint:styles:fix 检查或尝试修复 SCSS 中的问题
  • yarn lint:scriptsyarn lint:scripts:fix 检查或尝试修复 JS 中的问题