{"_id":"@bytelabsco/gorko","_rev":"1-cfcb26273adcb93167782025086af7ab","name":"@bytelabsco/gorko","dist-tags":{"latest":"0.9.1-fix"},"versions":{"0.9.1-fix":{"name":"@bytelabsco/gorko","version":"0.9.1-fix","description":"A tiny Sass token class generator.","main":"gorko.scss","dependencies":{"sass":"^1.26.5"},"scripts":{"test":"npx sass gorko.scss tmp/gorko.css && npx sass test/test.scss tmp/test.css"},"devDependencies":{"prettier":"^2.0.5"},"repository":{"type":"git","url":"git+https://github.com/hankchizljaw/gorko.git"},"keywords":[],"author":"","license":"ISC","bugs":{"url":"https://github.com/hankchizljaw/gorko/issues"},"homepage":"https://github.com/hankchizljaw/gorko#readme","publishConfig":{"access":"public"},"gitHead":"8f96fee40270b4cf63dfaa3200c55c9051adcd49","_id":"@bytelabsco/gorko@0.9.1-fix","_nodeVersion":"16.8.0","_npmVersion":"7.21.0","dist":{"integrity":"sha512-fgobC0N014LbNe0lSobMw0LnzIbSQg0J8eEv3V5u2n2vYqIPUM0Qvg5Qqrcw8hv38SwC4LpRhwngoYnbXcf9Pg==","shasum":"f98c743833b12c0815dca42aaf17d284b61cc43d","tarball":"https://registry.npmjs.org/@bytelabsco/gorko/-/gorko-0.9.1-fix.tgz","fileCount":24,"unpackedSize":53701,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhxKADCRA9TVsSAnZWagAAW7MP/0T5qHrtKSNUWe+pD0a/\nTxOh7oPbU+ZI93SY2E+QXwva9Jxu/PUOvq7G1pufSKGaeYsbf6qZk1OtHK5/\n8UlBmjRR+UiximHCp1VwXfiVsfPjC4nk7J5+RGqefuDQz7Pi7KlswpMFjdxj\n5dXO/eatMWZtfuDf5pMZLMQGbsOD47MPuKEwXEShWEUJpookT3us1zA3NG45\n2x9hpPiBMvNMaHia22DMGwHTgPtJ3JjfLhjevfhRE0Bem3OlDTliDLmJyAES\nBZfDL4x29tn4qQa7kvwB2DgKy63uI2w0PiBfNiNW2EK209yH6TWyi9uhmsAi\nHipm+tGidrXtYKrEvFSRkZIwHphccQjcRwUp4MiP1LoWH4NaVG6x/L/89HlM\n15BqCo0dcPqn1P9rPJVo50miEFW7DxCzY9Cekik0QhWnZ6tqLi4ja2bPrFoQ\nEXUnr8JvZv+IWmDckw2O6kLbgV5hZOAEG8Y4CfJoxF8xfvQvCr0b5I8Q7Eoa\nyqQc7CEIR0tOSs59dCndk4C6vbOqI/0agxXrpnMoLeto3E+T+8gttt6LU4ww\nQAjfSViixGrctcamzkBt4nQQ+lz72IWNKkzuYVxBnjVI2WwbC1HKKg/SGkIt\n86I8ROD90rwi0iDfVV/FcalRFaB10409hoWApK55sfpVgNygd22liq6DotO/\nX4u4\r\n=Fo8i\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHJYnPZHDD7F1iXpRBecaL/av9/kaUgx2xdCeBpOu4eZAiEAqf0pnASiSWnfaDBj6xES+CUB2IU+pKyVd73nYvj83h0="}]},"_npmUser":{"name":"bytelabsco","email":"jeremy@bytelabs.co"},"directories":{},"maintainers":[{"name":"bytelabsco","email":"jeremy@bytelabs.co"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gorko_0.9.1-fix_1640275971294_0.08829308783212642"},"_hasShrinkwrap":false}},"time":{"created":"2021-12-23T16:12:51.230Z","0.9.1-fix":"2021-12-23T16:12:51.492Z","modified":"2022-04-04T21:22:01.592Z"},"maintainers":[{"name":"bytelabsco","email":"jeremy@bytelabs.co"}],"description":"A tiny Sass token class generator.","homepage":"https://github.com/hankchizljaw/gorko#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/hankchizljaw/gorko.git"},"bugs":{"url":"https://github.com/hankchizljaw/gorko/issues"},"license":"ISC","readme":"# Gorko\n\nA tiny, Sass-powered design-token led utility class generator, with handy helpers, that helps you to power your front-ends with a single source of truth.\n\n## Table of contents\n\n- [Gorko](#gorko)\n  - [Getting started](#getting-started)\n  - [Configuration](#configuration)\n    - [Base size (optional)](#base-size--optional-)\n    - [Size scale (optional)](#size-scale--optional-)\n    - [Colors (optional)](#colors--optional-)\n    - [Gorko config (required)](#gorko-config--required-)\n    - [Breakpoints](#breakpoints)\n  - [Utility Class Generator](#utility-class-generator)\n    - [Example outputs](#example-outputs)\n  - [Generating Utility Classes On Demand](#generating-utility-classes-on-demand)\n  - [Using CSS Custom Properties](#using-css-custom-properties)\n    - [Using themes](#using-themes)\n  - [Sass functions](#sass-functions)\n    - [Get color](#get-color)\n      - [Example](#example)\n    - [Get utility value](#get-utility-value)\n      - [Example](#example-1)\n    - [Get size](#get-size)\n      - [Example](#example-2)\n  - [Sass mixins](#sass-mixins)\n    - [Apply utility](#apply-utility)\n      - [Example](#example-3)\n    - [Media query](#media-query)\n      - [Example](#example-4)\n  - [Contributing](#contributing)\n  - [Pull Request Process](#pull-request-process)\n  - [Code of Conduct](#code-of-conduct)\n    - [Our Pledge](#our-pledge)\n    - [Our Standards](#our-standards)\n    - [Our Responsibilities](#our-responsibilities)\n    - [Scope](#scope)\n    - [Enforcement](#enforcement)\n    - [Attribution](#attribution)\n\n## Getting started\n\nFirst up, install Gorko:\n\n```bash\nnpm install gorko\n```\n\nIn your Sass (SCSS in this case), import Gorko like so:\n\n```scss\n@import '../path/to/your/node_modules/gorko/gorko.scss';\n```\n\nThis will generate utility classes based on the default configuration. To configure it for yourself, take this default, and create your own. Once it is created **import your config before Gorko**, like this:\n\n```bash\n@import 'config';\n```\n\n## Configuration\n\nThis is the default configuration. It is recommended that you use it as your base for your own configuration.\n\n```scss\n/// BASE SIZE\n/// All calculations are based on this. It’s recommended that\n/// you keep it at 1rem because that is the root font size. You\n/// can set it to whatever you like and whatever unit you like.\n///\n$gorko-base-size: 1rem;\n\n/// SIZE SCALE\n/// This is a Major Third scale that powers all the utilities that\n/// it is relevant for (font-size, margin, padding). All items are\n/// calcuated off the base size, so change that and cascade across\n/// your whole project.\n///\n$gorko-size-scale: (\n  '300': $gorko-base-size * 0.8,\n  '400': $gorko-base-size,\n  '500': $gorko-base-size * 1.25,\n  '600': $gorko-base-size * 1.6,\n  '700': $gorko-base-size * 2,\n  '900': $gorko-base-size * 3\n);\n\n/// COLORS\n/// Colors are shared between backgrounds and text by default.\n/// You can also use them to power borders, fills or shadows, for example.\n///\n$gorko-colors: (\n  'dark': #1a1a1a,\n  'light': #f3f3f3\n);\n\n/// CORE CONFIG\n/// This powers everything from utility class generation to breakpoints\n/// to enabling/disabling pre-built components/utilities.\n///\n$gorko-config: (\n  'bg': (\n    'items': $gorko-colors,\n    'output': 'standard',\n    'property': 'background'\n  ),\n  'color': (\n    'items': $gorko-colors,\n    'output': 'standard',\n    'property': 'color'\n  ),\n  'box': (\n    'items': (\n      'block': 'block',\n      'flex': 'flex',\n      'hide': 'none',\n      'show': 'inherit'\n    ),\n    'output': 'responsive',\n    'property': 'display'\n  ),\n  'font': (\n    'items': (\n      'base': 'Helvetica, Arial, sans-serif'\n    ),\n    'output': 'standard',\n    'property': 'font-family'\n  ),\n  'gap-top': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'margin-top'\n  ),\n  'gap-right': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'margin-right'\n  ),\n  'gap-bottom': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'margin-bottom'\n  ),\n  'gap-left': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'margin-left'\n  ),\n  'pad-top': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'padding-top'\n  ),\n  'pad-right': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'padding-right'\n  ),\n  'pad-bottom': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'padding-bottom'\n  ),\n  'pad-left': (\n    'items': $gorko-size-scale,\n    'output': 'standard',\n    'property': 'padding-left'\n  ),\n  'stack': (\n    'items': (\n      '300': 0,\n      '400': 10,\n      '500': 20,\n      '600': 30,\n      '700': 40\n    ),\n    'output': 'standard',\n    'property': 'z-index'\n  ),\n  'text': (\n    'items': $gorko-size-scale,\n    'output': 'responsive',\n    'property': 'font-size'\n  ),\n  'weight': (\n    'items': (\n      'light': '300',\n      'regular': '400',\n      'bold': '700'\n    ),\n    'output': 'standard',\n    'property': 'font-weight'\n  ),\n  'width': (\n    'items': (\n      'full': '100%',\n      'half': percentage(1/2),\n      'quarter': percentage(1/4),\n      'third': percentage(1/3)\n    ),\n    'output': 'responsive',\n    'property': 'width'\n  ),\n  'breakpoints': (\n    'sm': '(min-width: 36em)',\n    'md': '(min-width: 48em)',\n    'lg': '(min-width: 62em)'\n  )\n);\n```\n\n### Base size (optional)\n\n`$gorko-base-size`\n\nThe base size for the size ratio calculations. It is only required for the default configuration.\n\n### Size scale (optional)\n\n`$gorko-size-scale`\n\nThis takes the base size and by default, generates a **major third** size scale. This can be set to whatever scale you like.\n\nIf this is not set, the `get-size` function will use the default configuration.\n\n### Colors (optional)\n\n`$gorko-colors`\n\nA collection of key/value pairs that by default, generate text and background colour utilities.\n\nIf this is not set, the `get-color` function will use the default configuration.\n\n### Gorko config (required)\n\n`$gorko-config`\n\n🚨 Without this set, Gorko won’t work. 🚨\n\nIt contains all of the utility class definitions and breakpoint definitions that the generator and mixins use.\n\nYou can add as many or as little utility class definitions as you like—likewise for breakpoint definitions.\n\n### Breakpoints\n\nThe `breakpoints` map in `$gorko-config` defines media queries for the utility class generator. By default, the are set as follows:\n\n```scss\n'breakpoints': (\n\t'sm': '(min-width: 36em)',\n\t'md': '(min-width: 48em)',\n\t'lg': '(min-width: 62em)'\n)\n```\n\nYou can add as many or as little of these as you like and call them whatever you like. The only requirement is that the value is a valid media query.\n\n## Utility Class Generator\n\nThe utility class generator loops through `$gorko-config` looking for items that have a valid utility class structure. The following structure is required to generate a utility class:\n\n```scss\n'width':('items':('full':'100%','half': '50%'\n  ),\n  'output': 'standard',\n  'property': 'width'\n),;\n```\n\nThe first key is the name of the utility and that contains a Sass map. Inside that map, you need to have the following:\n\n- `items`: a map of key/value pairs which link a utility class to a CSS property’s value. If you want to use CSS Custom Properties, this should be the string key, referencing the `'css-vars'` `$gorko-config` group that you want to use\n- `output`: this must be `responsive` or `standard`. If you set it to `responsive`, it will generate the same utility class for **every breakpoint that is defined**.\n- `property`: the [CSS property](https://css-tricks.com/almanac/properties/) that this utility controls.\n\n### Example outputs\n\nThe above structure would output the following utility classes:\n\n```css\n.width-full {\n  width: 100%;\n}\n\n.width-half {\n  width: 50%;\n}\n```\n\nIf we set the `output` to be `responsive`, with the default `breakpoints` defined, the output would be as follows:\n\n```css\n.width-full {\n  width: 100%;\n}\n\n.width-half {\n  width: 50%;\n}\n\n@media (min-width: 36em) {\n  .sm\\:width-full {\n    width: 100%;\n  }\n\n  .sm\\:width-half {\n    width: 50%;\n  }\n}\n\n@media (min-width: 48em) {\n  .md\\:width-full {\n    width: 100%;\n  }\n\n  .md\\:width-half {\n    width: 50%;\n  }\n}\n\n@media (min-width: 62em) {\n  .lg\\:width-full {\n    width: 100%;\n  }\n\n  .lg\\:width-half {\n    width: 50%;\n  }\n}\n```\n\n## Generating Utility Classes On Demand\n\nThe default behaviour of Gorko is to generate utility classes, but in the spirit of being as flexible as possible, you can stop it doing that by setting `$generate-utility-classes` to `false` when you pull Gorko into your project, like this:\n\n```scss\n$generate-utility-classes: false;\n@import 'config';\n@import '../path/to/your/node_modules/gorko/gorko.scss';\n```\n\nWe might want to generate those utility classes later on in the CSS, though, so we use the `generate-utility-classes()` mixin anywhere **after** Gorko has been pulled in.\n\n```scss\n$generate-utility-classes: false;\n@import 'config';\n@import '../path/to/your/node_modules/gorko/gorko.scss';\n\n// Standard authored CSS\nbody {\n  display: grid;\n  place-items: center;\n}\n\n// Generate utilities after everything else\n@include generate-utility-classes();\n```\n\n## Using CSS Custom Properties\n\n**[See a demo repo](https://github.com/andy-piccalilli/gorko-custom-props-demo)**\n\nYou might want to use CSS Custom Properties instead of static references to tokens. To do so with Gorko, you need to make a couple of adjustments to your `$gorko-config`.\n\nFirstly, at the top, you need to add a `css-vars` group which has a **key** and a value, which should be a map of tokens.\n\n```scss\n$gorko-config: (\n  'css-vars': (\n    'color': $gorko-colors,\n    'weight': (\n      'bold': 700,\n      'black': 900\n    )\n  )\n);\n```\n\nIn this example, we have defined a `'color'` group which uses `$gorko-colors`, but also a `'weight'` group where we have defined key value pairs, just like we do in the utility class generator.\n\nThis will now generate a collection of CSS Custom properties like this:\n\n```css\n:root {\n  --color-dark: #1a1a1a;\n  --color-light: #f3f3f3;\n  --weight-bold: 700;\n  --weight-black: 900;\n}\n```\n\nTo use CSS Custom Properties in a utility class, we need to first, switch `'items'` to be a reference to the `'css-vars'` group we want, then set `'css-vars'` to be `true`.\n\n```scss\n'bg': (\n  'items': 'color',\n  'css-vars': true,\n  'output': 'standard',\n  'property': 'background'\n)\n```\n\nNow, the background utility classes will look like this:\n\n```css\n.bg-dark {\n  background: var(--color-dark);\n}\n\n.bg-light {\n  background: var(--color-light);\n}\n```\n\n**Note**: You can use a combination of CSS Custom Properties _and_ static references to tokens for different utility classes. Gorko is flexible enough to let you do what works for you and your team.\n\nWhen you enable CSS custom properties, Gorko will generate the `:root` blocks for you, but sometimes, you might want those `:root` blocks not to be rendered. This is common if you are generating more than one CSS bundle. **To disable the generation of CSS Custom Property blocks, set `$generate-css-vars = false;`, before you import Gorko, just like [generating utility classes on demand](#generating-utility-classes-on-demand)**.\n\n### Using themes\n\n**This feature requires Custom Properties**\n\nA handy part of the Custom Property support with Gorko is the ability to generate multiple themes. These themes can power dark mode with `@media (prefers-color-scheme: dark)` or be prefixed with whatever scheme you like.\n\nLet’s say you want a dark mode that [both honours the user’s preference, via a media query, and also, can be toggled](https://piccalil.li/tutorial/create-a-user-controlled-dark-or-light-mode/). The toggle version could use `[data-theme=\"dark\"]` as its prefix. We’ll generate a default light theme too.\n\nFirst, we set some values.\n\n```scss\n$gorko-colors: (\n  'dark': #1a1a1a,\n  'light': #f3f3f3\n);\n\n$light-colors: (\n  'text': map-get($gorko-colors, 'dark'),\n  'bg': map-get($gorko-colors, 'light')\n);\n\n$dark-colors: (\n  'text': map-get($gorko-colors, 'light'),\n  'bg': map-get($gorko-colors, 'dark')\n);\n```\n\nThen, we tweak `$gorko-config`.\n\n```scss\n$gorko-config: (\n  'css-vars': (\n    'themes': (\n      'default': (\n        'tokens': (\n          'color': $light-colors\n        )\n      ),\n      'dark': (\n        'prefers-color-scheme': 'dark',\n        'tokens': (\n          'color': $dark-colors\n        )\n      ),\n      'dark-toggle': (\n        'prefix': '[data-theme=\"dark\"]',\n        'tokens': (\n          'color': $dark-colors\n        )\n      )\n    )\n  ),\n  /// the rest of your config\n);\n```\n\nThis then generates the following Custom Properties:\n\n```css\n:root {\n  --color-text: #1a1a1a;\n  --color-bg: #f3f3f3;\n}\n\n@media (prefers-color-scheme: dark) {\n  :root {\n    --color-text: #f3f3f3;\n    --color-bg: #1a1a1a;\n  }\n}\n\n[data-theme='dark'] {\n  --color-text: #f3f3f3;\n  --color-bg: #1a1a1a;\n}\n```\n\nNow, we can style elements like so and regardless of what theme is selected, we won’t have to change our CSS:\n\n```css\n.my-element {\n  background: var(--color-bg);\n  text: var(--color-text);\n}\n```\n\nA complete theme map looks like this:\n\n```scss\n'dark-toggle': ( // Name required\n  'prefix': '[data-theme=\"dark\"]', // Optional. Will be :root if not set\n  'prefers-color-scheme': 'dark', // Optional. Will generate @media rule if set\n  'tokens': ( // Required. Map of key value pairs\n    'color': (\n      'primary': #1a1a1a,\n      'secondary': #f3f3f\n    )\n  )\n)\n```\n\nYou can generate as many themes with whatever prefix you can think up!\n\nYou could also [generate color utility classes using the generator](#utility-class-generator) that use these custom properties.\n\n## Namespaces\nGorko supports 'namespacing' both the generated class and variable names by allowing you to specify a prefix.  This is done using the `namespace` map within `$gorko-config`.  The default `namespace` config looks like this:\n\n````scss\n$gorko-config: (\n  'namespace': (\n    'prefix': '',             // string\n    'classes': true,          // boolean or string\n    'css-vars': false         // boolean or string\n  )\n)\n````\n### Namespace Settings\n#### prefix\nSpecifying a value for `prefix` will append that value to classes (by default) and css variables (opt-in).  You are responsible for appending any separating character, such as a dash or underscore. For example, if your namespace is `my-app-`, you need to add the trailing `-` character in the `'prefix'` section.\n\n#### classes\nAccepts either a boolean value indicating that the `prefix` should be applied to generated utility classes OR a string, which allows you to override the global `prefix`\n\n#### css-vars\nAccepts either a boolean value indicating that the `prefix` should be applied to css-vars OR a string, which allows you to override the global `prefix`\n\n### Examples\n\nMinimal Configuration: This configuration would prepend `my-` to the beginning of generated utility classes, but would not modify css variable names:\n\n````scss\n$gorko-config: (\n  'namespace': (\n    'prefix': 'my-'\n  )\n)\n````\n\nEverything prefixed:  This configuration applies the prefix to both utility classes and css variables:\n\n````scss\n$gorko-config: (\n  'namespace': (\n    'prefix': 'my-',\n    'css-vars': true\n  )\n)\n````\n\nSeparate prefixes:  This configuration gives you the ability to provide different prefixes for utility classes and css variables:\n\n````scss\n$gorko-config: (\n  'namespace': (\n    'classes': 'my-class-',\n    'css-vars': 'my-var-'\n  )\n)\n````\n\n## Sass functions\n\nThere are a couple of handy functions that give you access to configuration settings.\n\n### Get color\n\n`get-color($key: string)`\n\nTakes the passed `$key` and attempts to retrieve a match from `$gorko-colors`.\n\n#### Example\n\nUsing the default config:\n\n```scss\n$dark = get-color('dark'); // #1a1a1a\n```\n\n### Get utility value\n\n`get-utility-value($key: string, $value-key: string)`\n\nReturns back the value for a utility class so you can use it directly.\n\n#### Example\n\nUsing the default config:\n\n```scss\nfont-weight: get-utility-value('weight', 'light'); // 300\n```\n\n### Get size\n\n`get-size($ratio-key: string)`\n\nTries to match the passed `$ratio-key` with the `$gorko-size-scale`. Returns null if it can’t find a match.\n\n#### Example\n\nUsing the default config:\n\n```scss\n$my-size: get-size('500'); // 1.25rem\n```\n\n## Sass mixins\n\n### Apply utility\n\n`apply-utility($key: string, $value-key: string)`\n\nGrab the property and value of one of the `$gorko-config` utilities that the generator will generate a class for.\n\n#### Example\n\nUsing the default config:\n\n```scss\n.my-element {\n  @include apply-utility('weight', 'bold'); // font-weight: bold;\n}\n```\n\n### Media query\n\n`media-query($key: string)`\n\nPass in the key of one of your breakpoints set in `$gorko-config['breakpoints']` and this mixin will generate the media query with your configured value.\n\n#### Example\n\nUsing the default config:\n\n```scss\n.my-element {\n  @include media-query('md') {\n    background: goldenrod;\n  }\n}\n```\n\nOutput:\n\n```css\n@media (min-width: 48em) {\n  .my-element {\n    background: goldenrod;\n  }\n}\n```\n\n## Contributing\n\nWhen contributing to this repository, please first discuss the change you wish to make via issue,\nemail, or any other method with the owners of this repository before making a change.\n\nPlease note we have a code of conduct, please follow it in all your interactions with the project.\n\n## Pull Request Process\n\n1. Ensure any install or build dependencies are removed before the end of the layer when doing a\n   build.\n2. Ensure your work is thoroughly tested, to the best of your abilities\n3. You may merge the Pull Request in once you have the sign-off from a maintainer\n\n## Code of Conduct\n\n### Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, gender identity and expression, level of experience,\nnationality, personal appearance, race, religion, or sexual identity and\norientation.\n\n### Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n- Using welcoming and inclusive language\n- Being respectful of differing viewpoints and experiences\n- Gracefully accepting constructive criticism\n- Focusing on what is best for the community\n- Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n- The use of sexualized language or imagery and unwelcome sexual attention or\n  advances\n- Trolling, insulting/derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or electronic\n  address, without explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n  professional setting\n\n### Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n### Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n### Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at me@andy-bell.design. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n### Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n","readmeFilename":"readme.md"}