Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/utilities/documentation #334

Merged
merged 18 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion config.json
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@
"about": "docs/content/about/*.hbs",
"develop": "docs/content/develop/*.hbs",
"design": "docs/content/design/*.hbs",
"methods": "docs/content/methods/*.hbs"
"methods": "docs/content/methods/*.hbs",
"utilities": "docs/content/utilities/*.hbs"
}
},
"inplace": {
Expand Down
5 changes: 5 additions & 0 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,11 @@ function metalsmithBuild(callback) {
refer: false,
sortBy: 'order',
},
utilities: {
pattern: config.metalSmith.collection.contentnav.utilities,
refer: false,
sortBy: 'order',
},
methods: {
pattern: config.metalSmith.collection.contentnav.methods,
refer: false,
Expand Down
1 change: 0 additions & 1 deletion src/core/_all.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
@import 'iconography/icon';
@import 'layout/layout';
@import 'section/section';
@import 'spacing/spacing';
@import 'typography/typography';
2 changes: 1 addition & 1 deletion src/core/colour/index.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ meta-index: true
<div class="nsw-in-page-alert__content">
<h4 class="nsw-in-page-alert__title">You don't need to use hex colours in code</h4>
<p>Use either CSS variables (below) or, if you're creating a one-off layout, you can use our helper classes for dark, light, and supplementary colours.</p>
<p>By using CSS variables, any branding or theming changes will automatically reflect in your product. See CSS variables below, or see the <a href="/docs/content/develop/helpers.html">Utility classes</a> docs.</p>
<p>By using CSS variables, any branding or theming changes will automatically reflect in your product. See CSS variables below, or see the <a href="/docs/content/utilities/background.html">Utility classes</a> docs.</p>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion src/core/graphic-elements/index.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ meta-index: true
Minimum padding from text: 16px</p>
</td>
<td>
<p><a href="/docs/content/develop/helpers.html#border-size">View Helper classes</a></p>
<p><a href="/docs/content/utilities/borders.html">View Helper classes</a></p>
</td>
</tr>
</tbody>
Expand Down
19 changes: 8 additions & 11 deletions src/core/pictograms/index.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,10 @@ meta-index: true
<h2 id="usage">Usage</h2>
<p>Used pictograms to visually support and highlight content, making it quickly identifiable on the page.</p>
<div class="nsw-in-page-alert nsw-in-page-alert--info">
<span class="material-icons nsw-material-icons nsw-in-page-alert__icon"
focusable="false" aria-hidden="true">info</span>
<span class="material-icons nsw-material-icons nsw-in-page-alert__icon" focusable="false" aria-hidden="true">info</span>
<div class="nsw-in-page-alert__content">
<h4>Use SVG utility classes</h4>
<p>Usability classes are available for developers to apply brand colours to SVGs. Use them so that SVGs can be used across pages using different colour schemes. See <a href="/docs/content/develop/helpers.html">Utility classes</a> for names.</p>
<p>Usability classes are available for developers to apply brand colours to SVGs. Use them so that SVGs can be used across pages using different colour schemes. See <a href="/docs/content/utilities/svg.html">Utility classes</a> for names.</p>
</div>
</div>
<h2 id="styling">Styling</h2>
Expand Down Expand Up @@ -94,15 +93,14 @@ meta-index: true
</div>
</div>

<div class="nsw-callout">
<div class="nsw-callout__content">
<h4>Pictogram Brand Styling</h4>
<p>For full pictograms creation guidance, visit your relevant brand classification guidelines at the <a href="https://branding.nsw.gov.au" target="_blank">NSW Government Visual identity system</a>.</p>
</div>
</div>
<div class="nsw-callout">
<div class="nsw-callout__content">
<h4>Pictogram Brand Styling</h4>
<p>For full pictograms creation guidance, visit your relevant brand classification guidelines at the <a href="https://branding.nsw.gov.au" target="_blank">NSW Government Visual identity system</a>.</p>
</div>
</div>



<!--<p>Pictograms should be designed on a pixel-based grid of 64px x 64px with a live area of 60px x 60px, and can be scaled down linearly to half size if required. Pictogram content should remain inside of the live area, which is the region of an image that is unlikely to be hidden from view (such as when sidebars appear upon scrolling).</p>
<div class="nsw-section nsw-section--white nsw-block nsw-p-sm">
<div class="nsw-table nsw-table--bordered nsw-table--valign-middle">
Expand Down Expand Up @@ -201,7 +199,6 @@ meta-index: true
<h3>Corner radius</h3>
<p>Corner radius should be 2px and increased where necessary to make rounded objects. Interior corners should be square.</p>


<div class="nsw-grid">
<div class="nsw-col nsw-col-sm-4">
<figure class="nsw-media nsw-media--light">
Expand Down
81 changes: 0 additions & 81 deletions src/core/spacing/_guidance.hbs

This file was deleted.

174 changes: 0 additions & 174 deletions src/docs/content/develop/helpers.hbs

This file was deleted.

Loading
Loading