Skip to content

About

Repository for AsBuiltReport static website

Resources

Stars

1 star

Watchers

2 watching

Forks

Latest commit

 

History

148 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AsBuiltReport Project.Website

Built with Material for MkDocs

This repository is for hosting the AsBuiltReport project website.

The project website is built using Material for MkDocs, together with ProperDocs.

Branding

The website carries the AsBuiltReport brand: a PowerShell prompt on a sheet of paper, the classic PowerShell console blue, and a highlighter yellow taken from the health check highlights in a report.

Tagline: Document your datacenter with PowerShell

Logo

AsBuiltReport mark

The chevron and cursor read as a PowerShell prompt. Together with the two lines above the cursor they read as lines of a document.

The primary mark with wordmark and tagline on a light background, the reversed mark on console blue, and the favicon at four sizes

File Use
asbuiltreport-mark.svg Primary mark, for light backgrounds
asbuiltreport-mark-reversed.svg White version for console blue and other dark backgrounds. Used in the site header
asbuiltreport-mark.png 512 px PNG of the primary mark, for places that do not accept SVG
favicon.svg, favicon.png Simplified square version for small sizes. Used as the site favicon

All logo files are in docs/assets/images/logos.

Guidelines:

  • Use the reversed mark on any dark background. The primary mark's blue page disappears there.
  • Below 24 px, use the favicon version. The two document lines in the full mark do not survive at that size.
  • The wordmark is "AsBuiltReport" set in Archivo at weight 800 and width 112%, in one colour.
  • Do not recolour, stretch or rotate the mark.

Repository banner

Every repository README opens with the same banner as the organisation profile: the reversed mark, the wordmark, the repository name in Cascadia Code with a yellow prompt, and a yellow edge. Module repositories show their install command on the last line, for example PS> Install-Module AsBuiltReport.VMware.vSphere, or their GitHub address until the module is on the PowerShell Gallery. This repository has no PowerShell install, so it shows the website address instead.

The banners for every repository, and the module tiles on the organisation profile, are rendered from one template by the brand asset generator in the .github repository, into assets/repo-banners. Change the design there, not in each repository.

README section icons

Section headings in module READMEs, such as Getting Started, System Requirements, Required Privileges, Module Installation, Configuration, Examples and Known Issues, use an icon in place of an emoji. The icons follow the feature icons on the website: an Octicons glyph in console blue on a highlighter yellow tile, with a 4 px corner on a 32 px tile.

Put the icon before the heading text, with empty alt text because the heading already names the section, and size it to the heading: 28 for #, 24 for ## and 20 for ###.

## <img src="https://raw.githubusercontent.com/AsBuiltReport/.github/main/assets/section-icons/getting-started.svg" alt="" width="24" height="24" align="top"> Getting Started

The full set, with the heading each icon is for, is in the section icon catalogue. The icons are generated by the same brand asset generator. To add one, add an entry to its section-icons.json.

README badges

Badges use the brand palette by what they show. Licence, last commit and social badges keep their default colours.

Badge Colour Examples
Versions Link blue #1F5FD0 PowerShell Gallery version
Counts Console blue #012456 Gallery downloads, GitHub contributors
Compatibility Highlighter #FFD02B PowerShell platform

Set the colour with the color parameter on the shields.io URL, for example https://img.shields.io/powershellgallery/v/AsBuiltReport.Core.svg?color=1F5FD0. Shields uses dark text on the highlighter automatically.

Health check highlight swatches

HealthCheck tables in module READMEs show the colour a report gives a highlighted cell with a small swatch, such as #FFF4C7 Warning and #FEDDD7 Critical. Link to the swatches in the central catalogue, never to a placeholder image service, and use the colour the module's report style uses: the AsBuiltReport.Core colours unless the module defines its own style.

![Warning](https://raw.githubusercontent.com/AsBuiltReport/.github/main/assets/highlight-swatches/FFF4C7.svg) VM snapshot age >= 7 days

These colours belong to the reports, not the brand, so they do not follow the palette above. When a module adds its own style, add its colours to highlight-swatches.json in the brand asset generator.

New modules get the banner, section icons, badge colours and highlight swatches from the Plaster template.

Colours

Swatch Name Hex Use
#012456 Console blue #012456 Header, hero, headings, code blocks, table headings
#FFD02B Highlighter #FFD02B Primary buttons, step numbers, icon tiles, commands in code, the cursor bar under headings
#FFE9A3 Highlighter tint #FFE9A3 Health check highlight (==text== in Markdown), strings in code
#1F5FD0 Link blue #1F5FD0 Links on light backgrounds
#9DB7E8 Parameter #9DB7E8 Parameters and comments in code, rules on blue
#E9EFF8 Tracing #E9EFF8 Inline code and quiet panels in light mode
#0A1A33 Ink #0A1A33 Body text in light mode
#4A5B78 Slate #4A5B78 Secondary text in light mode
#C5D2E6 Rule #C5D2E6 Borders and table rules in light mode

Dark mode keeps console blue and highlighter and swaps the neutrals:

Swatch Name Hex Use
#06142B Page #06142B Page background
#0B2147 Surface #0B2147 Panels and bands
#24406F Border #24406F Borders and table rules
#E6EDF8 Text #E6EDF8 Body text
#A9BCDD Muted #A9BCDD Secondary text
#8AB4FF Link #8AB4FF Links

Yellow is never used for text on a light background, because the contrast is too low. On light backgrounds it is a fill with console blue text or icons on top.

Typography

Type specimen showing Archivo for headings and body text, and Cascadia Code for a PowerShell command

Typeface Use Notes
Archivo Headings and body text Headings at weight 800 and width 112%. Body at weight 400
Cascadia Code Code only The Windows Terminal typeface

Both typefaces are self-hosted in docs/assets/fonts under the SIL Open Font License, so the site makes no requests to a font service. The licence files are in the same folder.

Where the brand is defined

File What it controls
docs/assets/stylesheets/extra.css Colours, fonts, light and dark schemes, code block and table styles, and the home page layout. The brand colours are set once at the top of the file
overrides/home.html The home page hero
docs/index.md The home page sections below the hero, in Markdown
properdocs.yml Logo, favicon, light and dark palette toggle, and social card colours

When extra.css changes, update the version on its path under extra_css in properdocs.yml (currently extra.css?v=2026.11.13), so browsers fetch the new file and do not use a cached copy.

About

Repository for AsBuiltReport static website

Resources

Stars

1 star

Watchers

2 watching

Forks

Contributors

Languages