Skip to content

Commit

Permalink
fix: update urls
Browse files Browse the repository at this point in the history
  • Loading branch information
redonkulus committed Sep 17, 2024
1 parent bb6dfab commit 41c1f6a
Show file tree
Hide file tree
Showing 10 changed files with 9,912 additions and 26 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ selector { property: value }
The generation process involves 2 main parts:
1. **Rules & Helpers**: All CSS rules available in Atomizer. Atomic rules will map to valid standards-compliant CSS properties. Helpers are rules not related to a single CSS property, but it usually bundles some useful features you will repeteadly find in common CSS constructs (e.g. `Cf` for clearfix, `Hidden` to visually hide content from sighted users but available to screen-readers, `LineClamp` and `Ellipsis` to add ellipsis to lines of text). Both rules and helpers follow the same syntax, read our [guide](https://acss.io/guides/custom-classes.html#rule-options) for more info.
1. **Rules & Helpers**: All CSS rules available in Atomizer. Atomic rules will map to valid standards-compliant CSS properties. Helpers are rules not related to a single CSS property, but it usually bundles some useful features you will repeteadly find in common CSS constructs (e.g. `Cf` for clearfix, `Hidden` to visually hide content from sighted users but available to screen-readers, `LineClamp` and `Ellipsis` to add ellipsis to lines of text). Both rules and helpers follow the same syntax, read our [guide](https://acss-io.github.io/atomizer/guides/custom-classes.html#rule-options) for more info.
Examples:
Expand Down Expand Up @@ -161,11 +161,11 @@ Examples:
}
```
2. [Configuration](https://acss.io/configuration.html): This is the actual source of truth for Atomizer when creating the CSS. It is a simple JS object containing 4 keys: `custom`, `breakPoints`, `classNames`, and `exclude`. The configuration file will come from the consumer of Atomizer. It can be manually passed, automatically generated after scanning files or a mix of both (e.g. Manually create a config file, define some custom classes, and let the tool find the classes in my project and merge the results in a final config output). Please note that classes defined in `custom` won't be generated in the final CSS unless they are **used** (passed in `classNames`).
2. [Configuration](https://acss-io.github.io/atomizer/configuration.html): This is the actual source of truth for Atomizer when creating the CSS. It is a simple JS object containing 4 keys: `custom`, `breakPoints`, `classNames`, and `exclude`. The configuration file will come from the consumer of Atomizer. It can be manually passed, automatically generated after scanning files or a mix of both (e.g. Manually create a config file, define some custom classes, and let the tool find the classes in my project and merge the results in a final config output). Please note that classes defined in `custom` won't be generated in the final CSS unless they are **used** (passed in `classNames`).

Please see the [example config file](https://github.com/acss-io/atomizer/blob/main/examples/atomizer.config.js) as it contains useful comments to understand what each key does.

[bsd license]: https://github.com/acss-io/atomizer/blob/main/LICENSE.md
[monorepo]: https://en.wikipedia.org/wiki/Monorepo
[support]: https://acss.io/support.html
[support]: https://acss-io.github.io/atomizer/support.html
[workspaces]: https://docs.npmjs.com/cli/v8/using-npm/workspaces
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: 'An unopinionated CSS utility library for modern websites.'
destination: ./_site
baseurl: '/atomizer/'
disable_disk_cache: true
logo: https://acss.io/images/android-chrome-512x512.png
logo: https://acss-io.github.io/atomizer/images/android-chrome-512x512.png
markdown: kramdown
highlighter: rouge
defaults:
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/quotes.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"author": "Max Heiber",
"link": "https://twitter.com/maxheiber/status/1334247383455117321?s=20&t=yMffS2mp0eK9GhavtsYX1Q",
"role": "@maxheiber",
"quote": "Atomic CSS tickles me: https://acss.io. It's a DSL that you write in class names. Atomizer makes the browser understand the subset you use. There's potential to take this much further"
"quote": "Atomic CSS tickles me: https://acss-io.github.io/atomizer. It's a DSL that you write in class names. Atomizer makes the browser understand the subset you use. There's potential to take this much further"
},
{
"author": "Peter Hecker",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/custom-classes.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ An `object` of custom rules used by helper classes. `rules` can be defined if th
type: 'helper',
name: 'Ellipsis',
description: 'Use to create a one-liner with ellipsis (in browsers that support text-overflow:ellipsis).',
link: 'https://acss.io/guides/helper-classes.html#-ell-ellipsis-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#-ell-ellipsis-',
matcher: 'Ell',
noParams: true,
styles: {
Expand Down
6 changes: 3 additions & 3 deletions packages/atomizer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,13 +310,13 @@ The `writing-mode` CSS property sets whether lines of text are laid out horizont

### Minor Changes

- 4729532: feat: We have a new `content` option property as part of the `atomizer.config.js` file. Which lets you configure various paths to source files for your project. Please take a look at the [Content guide](https://acss.io/content.html) for more info.
- 4729532: feat: We have a new `content` option property as part of the `atomizer.config.js` file. Which lets you configure various paths to source files for your project. Please take a look at the [Content guide](https://acss-io.github.io/atomizer/content.html) for more info.

## 3.17.0

### Minor Changes

- f4dffac: feat: add scroll snap support. Read the [Scroll Snap](https://acss.io/tutorials/scroll.html) docs for details and examples.
- f4dffac: feat: add scroll snap support. Read the [Scroll Snap](https://acss-io.github.io/atomizer/tutorials/scroll.html) docs for details and examples.

## 3.16.2

Expand All @@ -340,7 +340,7 @@ The `writing-mode` CSS property sets whether lines of text are laid out horizont

#### New Classes

- 389b42e: feat: Updated the box alignment logic to match the spec. Check out the [Alignment guide](https://acss.io/tutorials/alignment.html) for more info
- 389b42e: feat: Updated the box alignment logic to match the spec. Check out the [Alignment guide](https://acss-io.github.io/atomizer/tutorials/alignment.html) for more info
- 3b44d94: feat: Added `outline-offset` rule
- 5b2f69c: feat: Added blend modes
- 2b0409a: feat: Added missing pseudo elements
Expand Down
30 changes: 15 additions & 15 deletions packages/atomizer/src/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module.exports = [
type: 'helper',
name: 'Border',
description: 'Creates a 1px border on all edges of a box',
link: 'https://acss.io/guides/helper-classes.html#-bd-borders-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bd-borders',
matcher: 'Bd',
noParams: true,
styles: {
Expand All @@ -39,7 +39,7 @@ module.exports = [
type: 'helper',
name: 'Border X 1px solid',
description: 'Creates a 1px border on the left and right edges of a box',
link: 'https://acss.io/guides/helper-classes.html#-bd-borders-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bd-borders',
matcher: 'BdX',
noParams: true,
styles: {
Expand All @@ -55,7 +55,7 @@ module.exports = [
type: 'helper',
name: 'Border Y 1px solid',
description: 'Creates a 1px border on the top and bottom edges of a box',
link: 'https://acss.io/guides/helper-classes.html#-bd-borders-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bd-borders',
matcher: 'BdY',
noParams: true,
styles: {
Expand All @@ -71,7 +71,7 @@ module.exports = [
type: 'helper',
name: 'Border Top 1px solid',
description: 'Creates a 1px border on the top edge of a box',
link: 'https://acss.io/guides/helper-classes.html#-bd-borders-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bd-borders',
matcher: 'BdT',
noParams: true,
styles: {
Expand All @@ -87,7 +87,7 @@ module.exports = [
type: 'helper',
name: 'Border End 1px solid',
description: 'Creates a 1px border on the right edge of a box (in a LTR context)',
link: 'https://acss.io/guides/helper-classes.html#-bd-borders-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bd-borders',
matcher: 'BdEnd',
noParams: true,
styles: {
Expand All @@ -103,7 +103,7 @@ module.exports = [
type: 'helper',
name: 'Border Bottom 1px solid',
description: 'Creates a 1px border on the bottom edge of a box',
link: 'https://acss.io/guides/helper-classes.html#-bd-borders-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bd-borders',
matcher: 'BdB',
noParams: true,
styles: {
Expand All @@ -119,7 +119,7 @@ module.exports = [
type: 'helper',
name: 'Border Start 1px solid',
description: 'Creates a 1px border on the left edge of a box (in a LTR context)',
link: 'https://acss.io/guides/helper-classes.html#-bd-borders-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bd-borders',
matcher: 'BdStart',
noParams: true,
styles: {
Expand All @@ -141,7 +141,7 @@ module.exports = [
type: 'helper',
name: 'Block-formatting context',
description: 'Creates a block-formatting context',
link: 'https://acss.io/guides/helper-classes.html#-bfchack-block-formatting-context-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#bfchack-block-formatting-context',
matcher: 'BfcHack',
noParams: true,
styles: {
Expand All @@ -158,7 +158,7 @@ module.exports = [
type: 'helper',
name: 'Clearfix',
description: 'Allows an element to clear its child elements',
link: 'https://acss.io/guides/helper-classes.html#-cf-clearfix-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#cf-clearfix',
matcher: 'Cf',
noParams: true,
styles: {},
Expand All @@ -182,7 +182,7 @@ module.exports = [
type: 'helper',
name: 'Ellipsis',
description: 'Use to create a one-liner with ellipsis (in browsers that support text-overflow:ellipsis).',
link: 'https://acss.io/guides/helper-classes.html#-ell-ellipsis-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#ell-ellipsis',
matcher: 'Ell',
noParams: true,
styles: {
Expand Down Expand Up @@ -214,7 +214,7 @@ module.exports = [
type: 'helper',
name: 'Hiding content from sighted users',
description: 'Hides content from sighted users but leaves it accessible to screen readers',
link: 'https://acss.io/guides/helper-classes.html#hiding-content-from-sighted-users',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#hiding-content-from-sighted-users',
matcher: 'Hidden',
noParams: true,
styles: {
Expand All @@ -237,7 +237,7 @@ module.exports = [
type: 'helper',
name: 'Inline-block box',
description: 'Shorthand for styling inline-block constructs cross-browser',
link: 'https://acss.io/guides/helper-classes.html#-ibbox-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#ibbox',
matcher: 'IbBox',
noParams: true,
styles: {
Expand All @@ -258,7 +258,7 @@ module.exports = [
type: 'helper',
name: 'Line clamp',
description: 'Truncates long lines of text to a max number of lines',
link: 'https://acss.io/guides/helper-classes.html#-ibbox-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#ibbox',
matcher: 'LineClamp',
styles: {
'-webkit-line-clamp': '$0',
Expand Down Expand Up @@ -304,7 +304,7 @@ module.exports = [
type: 'helper',
name: 'Row',
description: 'Styles a box that expands to fill its container, contains floats, and more',
link: 'https://acss.io/guides/helper-classes.html#-row-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#row',
matcher: 'Row',
noParams: true,
styles: {
Expand All @@ -325,7 +325,7 @@ module.exports = [
type: 'helper',
name: 'Stretched box',
description: 'Stretches a box inside its containing block',
link: 'https://acss.io/guides/helper-classes.html#-stretchedbox-',
link: 'https://acss-io.github.io/atomizer/guides/helper-classes.html#stretchedbox',
matcher: 'StretchedBox',
noParams: true,
styles: {
Expand Down
2 changes: 1 addition & 1 deletion packages/postcss-atomizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ module.exports = {
};
```

The plugin will automatically execute Atomizer based on your project's [`atomizer.config.js`](https://acss.io/configuration.html) file and pass the rendered CSS to any additional plugins you configure.
The plugin will automatically execute Atomizer based on your project's [`atomizer.config.js`](https://acss-io.github.io/atomizer/configuration.html) file and pass the rendered CSS to any additional plugins you configure.

### Options

Expand Down
2 changes: 1 addition & 1 deletion packages/webpack-atomizer-loader/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# webpack-atomizer-loader [![npm version](https://badge.fury.io/js/webpack-atomizer-loader.svg)](http://badge.fury.io/js/webpack-atomizer-loader)

[Webpack loader](https://webpack.js.org/concepts/loaders) for compiling [Atomic CSS](https://acss.io).
[Webpack loader](https://webpack.js.org/concepts/loaders) for compiling [Atomic CSS](https://acss-io.github.io/atomizer).

## Table of Contents

Expand Down
Loading

0 comments on commit 41c1f6a

Please sign in to comment.