@a-ui/acpaas 中文文档教程
ACPaaS Branding
该项目包含 ACPaaS 的数字样式和样式指南。 这是为 ACPaaS 设计您的应用程序或网站样式的起点。
Getting started
在最简单的形式中，您只需在应用的 部分中包含以下行。
<link rel="stylesheet" href="https://cdn.antwerpen.be/acpaas_branding_scss/4.3.0/main.min.css">
您甚至可以直接将其导入您的 (S)CSS：
@import url("https://cdn.antwerpen.be/acpaas_branding_scss/4.3.0/main.min.css");
我们采用语义版本控制。 如果您想使用其他版本的 ACPaaS 品牌，您可以通过调整 URL 地址中的版本来实现。 查看所有可用版本的变更日志。
你也可以用 npm 安装所有东西：
npm install @a-ui/acpaas --save
Development
Prerequisites
为了运行这个项目并查看所有可用的组件，你需要有 NodeJS 和 Gulp 安装。
Installing
转到该项目的根目录并在命令行中运行以下命令：
npm install
然后，您可以导入 Sass 设置中的所有内容（main.min.css 也可用）：
@import '@a-ui/acpaas/dist/main.css';
为了扩展我们的样式你可以使用我们的 Sass 变量。 像这样导入它们：
@import '@a-ui/acpaas/dist/assets/styles/_quarks.scss';
Local development
在命令行中
gulp server
Building
以下命令：
gulp build
Creating your own customized build
运行 文件。 您将能够用您自己的变量覆盖我们的变量（颜色、间距等）。
查找
_quarks.colors.scss和_quarks.variables.scss文件以查看您可以覆盖的所有变量。
Contributing
// 目前，请通过 branding@stad.antwerpen.be 联系我们。
Versioning
我们使用 SemVer 进行版本控制。 有关可用版本，请参阅此存储库上的标签。
Authors
- Tom Wuyts - Initial work, UX designer
- Jasper Van Proeyen - Initial work, lead developer
另请参阅参与此项目的贡献者列表。
License
这个项目是根据 MIT 许可证的修改版本获得许可的。 有关详细信息，请参阅 LICENSE.md 文件。
ACPaaS Branding
This project contains ACPaaS' digital styling and styling guidelines. It is the starting point to style your app or website for ACPaaS.
Getting started
In its simplest form you can just include the following line in the <head> section of your app.
<link rel="stylesheet" href="https://cdn.antwerpen.be/acpaas_branding_scss/4.3.0/main.min.css">
You can even import it directly in your (S)CSS:
@import url("https://cdn.antwerpen.be/acpaas_branding_scss/4.3.0/main.min.css");
We adopt semantic versioning. If you want to use another version of the ACPaaS Branding you can do so by adjusting the version in the URL address. See the changelog for all available versions.
You can also install everything with npm:
npm install @a-ui/acpaas --save
Development
Prerequisites
In order to run this project and see all available components, you'll need to have NodeJS and Gulp installed.
Installing
Go to the root of this project and run the following command in your command line:
npm install
Then, you can import everything in your Sass setup (main.min.css also available):
@import '@a-ui/acpaas/dist/main.css';
In order to extend our style kit you can make use of our Sass variables. Import them like this:
@import '@a-ui/acpaas/dist/assets/styles/_quarks.scss';
Local development
Run the following command in your command line:
gulp server
Building
Run the following command in your command line:
gulp build
Creating your own customized build
To apply your own style to the kit, import it into your project and use the accompanied .scss files. You will be able to overwrite our variables (for colors, spacing, etc.) with your own.
Look for the
_quarks.colors.scssand_quarks.variables.scssfiles to see all variables you can overwrite.
Contributing
// For now, contact us via branding@stad.antwerpen.be.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Tom Wuyts - Initial work, UX designer
- Jasper Van Proeyen - Initial work, lead developer
See also the list of contributors who participated in this project.
License
This project is licensed under a modified version of the MIT license. See the LICENSE.md file for details.
