Open GIS Styleguide
The single source for Open GIS docs and site styling. One hosted stylesheet — assets/css/ogis.css — bundles Pico CSS, the Open GIS theme and the highlight.js syntax palette, so consumers link it and, for highlighted code, add the highlight.js runtime. It also ships the Open GIS logo set, a small page UI and an optional background map. A change here updates every site that links it.
Every section below is both the documentation and the live demo.
Terminology
Always write the organisation as Open GIS — two words, both capitalised — in prose, headings, titles, alt text and documentation. Never run the words together or vary the case.
Downstream projects refer to it in one of two approved ways: the name (plain or linked) or the linked domain ogis.org. Link the first mention on each page to ogis.org.
Approved forms
| Form | Markup |
|---|---|
| Open GIS | Open GIS |
| Open GIS (link) | <a href="https://www.ogis.org">Open GIS</a> |
| ogis.org (link) | <a href="https://www.ogis.org">ogis.org</a> |
Never
Caution
Do not use these variants as a name:
opengisOpenGISopen gisOpengisOPEN GIS
Identifiers
Lowercase ogis is for code-facing identifiers: ogis.css, --ogis-*, tile.ogis.org, and package names such as ogis-branding. The GitHub organisation and repository keep their existing casing: OpenGIS/branding. The letter grid in the logo is a mark, not a written reference.
Quick Start
Link the one hosted stylesheet — it already carries Pico CSS, the Open GIS theme and the syntax palette. Add highlight.js only if you want highlighted code blocks. The default is to load directly from the ogis.org domain; forking or self-hosting sets NUXT_PUBLIC_SITE_URL, which drives the canonical link and the generated docs URLs.
<link rel="stylesheet" href="https://www.ogis.org/branding/assets/css/ogis.css">
<link rel="icon" href="https://www.ogis.org/branding/assets/img/logo-green.png">
<!-- Optional: highlight code blocks -->
<script src="/your/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
The hosted assets, by type:
| Asset | Type | Purpose |
|---|---|---|
ogis.css |
CSS | Pico CSS, Open GIS theme, components and syntax palette |
background-map.js |
JS | Optional random-country map module |
logo.html |
HTML | Self-contained default logo snippet |
logo-white.svg |
SVG | White mark for dark surfaces |
logo-black.svg |
SVG | Black mark for light surfaces |
logo-green.png |
PNG | Green tile for favicons and raster use |
Docs page
A docs page reuses the header and section nav above, then closes with a prev/next pager:
Background Map
One optional module gives any element a random country background, powered by the hosted Waymark-JS v1 viewer. Mark a container with data-background-map and load the module once; it injects the viewer's CSS, jQuery and bundle (see Dependencies) and centres a country at zoom 8. The map is decorative and fixed: random and non-interactive, with no scroll, drag, pinch, double-click or keyboard zoom.
Live demo — the container above carries only the attribute and a height. Reload the page for a different country. This page's header wears the same module with data-background-map="invert", since the header band is always dark.
<!-- Any block; set its height however you like. -->
<div data-background-map style="height: 220px"></div>
<script src="https://www.ogis.org/branding/assets/js/background-map.js" defer></script>
The built file exposes window.BackgroundMap.init() and window.BackgroundMap.refresh() for containers added after load. Force the always-dark look on a dark band with the invert modifier:
<div data-background-map="invert"></div>
<!-- or -->
<div class="background-map--invert" data-background-map></div>
Logo
The mark is the 2×2 letter grid — globe, G, I, S — with a thin cross grid. The default is the self-contained HTML logo; three file assets cover <img>, raster and favicon contexts.
HTML logo (default)
One copy-pasteable snippet: inline CSS only, no stylesheet and no external requests. It is both the mark and the link to ogis.org. Monochrome via currentColor, so set color on the wrapper to flip black/white; square with a transparent background. Everything is em-based at a default font-size: 40px — change it to scale.
The full markup lives in the canonical hosted snippet at assets/html/logo.html. Wrap it to control colour and size:
<a
href="https://www.ogis.org/"
title="Open GIS"
aria-label="Open GIS"
style="
display: inline-block;
margin: 0;
font-size: 40px;
line-height: 1;
color: currentColor;
text-decoration: none;
"
>
<!-- Paste the inline table from assets/html/logo.html. -->
</a>
logo-white.svg
White mark for dark surfaces. Reference it as an <img> over the near-black header band.
<img src="https://www.ogis.org/branding/assets/img/logo-white.svg" alt="" width="40" height="40">
logo-black.svg
Black mark for light surfaces. Reference it as an <img> on light backgrounds.
<img src="https://www.ogis.org/branding/assets/img/logo-black.svg" alt="" width="40" height="40">
logo-green.png
Green tile for favicons and raster contexts such as app icons and social cards. A 512×512 PNG; link it as the page icon.
<link rel="icon" href="https://www.ogis.org/branding/assets/img/logo-green.png">
Assets
| Asset | Format | Use |
|---|---|---|
logo.html |
HTML | Default self-contained mark and link |
logo-white.svg |
SVG | White mark for dark surfaces |
logo-black.svg |
SVG | Black mark for light surfaces |
logo-green.png |
PNG | 512×512 green tile for favicons, app icons and social cards |
Palette
Both palettes are shown together so they are visible in either mode. Dark deepens the org surfaces to #000b00 / #001800 with the neon accent #0dd70d; light warms the page to #fcfaf5 with sage bands and an AA-compliant darker green for links. Orange (#b3571f / #dc8f4e) is a first-class accent beside the green.
Light
Dark
Tokens
| Token | Light | Dark |
|---|---|---|
--ogis-bg |
#fcfaf5 |
#000b00 |
--ogis-bg-alt |
#f0f1e6 |
#001800 |
--ogis-surface |
#fffefb |
#001300 |
--ogis-fg |
#2b3129 |
#eeeeee |
--ogis-heading |
#18281a |
#e8f5ea |
--ogis-muted |
#61685b |
#9bb0a3 |
--ogis-border |
#dddccd |
#0e3111 |
--ogis-accent |
#0a7d0a |
#0dd70d |
--ogis-accent-hover |
#06630a |
#5cf05c |
--ogis-orange |
#b3571f |
#dc8f4e |
--ogis-orange-hover |
#914417 |
#e8a869 |
--ogis-code-block-bg |
#e7e4d6 |
#1a1a1a |
Colour notes
- AA darker green. Neon
#0dd70dfails contrast on light surfaces, so light links and accents use#0a7d0a, measured at 5.1:1 on--ogis-bg. - Neon dark accent. Dark keeps the org neon
#0dd70d, which reads cleanly on the near-black surfaces. - Orange is first-class. Orange sits beside the green primary for swatches and accents; it no longer carries the secondary button.
Dark vs Light
The theme ships a light and a dark token set. With nothing set it follows your operating system through prefers-color-scheme. A page can force a scheme by setting data-theme="light" or data-theme="dark" on the root element; removing the attribute returns to the OS default. The control below demonstrates it live — the whole page switches, and nothing is stored.
<!-- Force a scheme; omit the attribute to follow the OS. -->
<html data-theme="dark">
Light warms the page to #fcfaf5 with sage #f0f1e6 bands and an AA-compliant green for links (#0a7d0a). Dark deepens the org surfaces to #000b00 / #001800 with the neon accent #0dd70d. Orange (#b3571f / #dc8f4e) is a first-class accent in both. Add <meta name="color-scheme" content="light dark"> so the browser agrees with the theme about which scheme is available.
See the Palette for the full token table.
Typography
Full monospace throughout at 15 px/1.65; code at 13 px. Blockquotes step up to a larger warm serif (25 px) with a hanging opening quote mark, a closing mark and an accent rule. No webfonts, so there are zero font requests.
The specimen below shows the heading scale, body copy, lists, a blockquote and the focus state. Anchored headings inherit the heading colour, with a hash hint in the secondary orange on hover or keyboard focus.
Heading one
Heading two
Heading three
Heading four
Heading five
Heading six
Anchored headings inherit the heading colour; a hash hint in the secondary orange appears on hover or keyboard focus.
Body copy set in a calm monospace measure. Inline code chips sit on a soft panel, strong and emphasis carry the usual weight shifts, and links take the theme accent with a dotted underline that turns solid on hover or focus.
- Unordered list item
- Second item with
inline code
- Ordered list item
- Second item
Open source means freedom of choice, collaboration and innovation.
Links, buttons and form controls take the theme accent with a 2px solid var(--ogis-accent) focus ring at a 2 px offset — tab to this link to see it.
Alerts
Five types share one grey surface and keep their colour coding in the accent — border, icon and label.
Note
Useful information that readers should know, even when skimming.
Tip
Optional information that helps readers succeed.
Important
Key information readers need to reach their goal.
Warning
Urgent information that needs immediate attention.
Caution
Advise about the consequences of certain actions.
Forms
Pico's form basics inherit the theme tokens: surfaces, borders and the neon focus ring. The demo below pairs a standard form with the theme's call-to-action links and Pico buttons.
Buttons and calls to action
.cta is the primary call to action; add .cta-quiet for an outlined variant. Pico's .secondary button covers the quieter button style.
<a class="cta" href="#">Primary CTA</a>
<a class="cta cta-quiet" href="#">Quiet CTA</a>
<button type="button" class="secondary">Secondary</button>
Code
The syntax palette lives in ogis.css alongside the rest of the theme, keyed on highlight.js language classes. The styleguide loads highlight.js 11.12.0 from npm; give a block a language-* class and it highlights on load. Every block has a one-click copy control in the top-right; long lines wrap, so nothing scrolls sideways.
Inline code is a plain chip by default — map.on("ready") — but a chip carrying language-* highlights: use raw inline HTML map.on("ready") so the runtime inline-highlight pass can pick it up.
// Tile a Waymark map
import { Map } from "waymark-js";
const map = new Map("map", { style: "terrain" });
map.on("ready", () => {
console.log("tiles loaded");
});
# Fetch the tile catalogue
curl -s https://tile.ogis.org/sources | jq .
# Health check
curl -s https://tile.ogis.org/health
Dependencies
The theme and its exports build on these third-party projects.
| Dependency | Version | How it is used |
|---|---|---|
| Pico CSS | 2.1.1 | Bundled into ogis.css (npm). |
| highlight.js | 11.12.0 | Runtime added by the consumer; the syntax palette ships in ogis.css. |
| jQuery | 3.7.1 | Fetched at runtime by the background-map export only. |
| Waymark-JS | v1 | Fetched at runtime by the background-map export only. |
