diff --git a/.gitignore b/.gitignore index b2d6de3..55ee151 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ /build # Generated files +.atl .docusaurus .cache-loader diff --git a/docs/tutorial-basics/markdown-features.mdx b/docs/tutorial-basics/markdown-features.mdx index e739ec4..3085337 100644 --- a/docs/tutorial-basics/markdown-features.mdx +++ b/docs/tutorial-basics/markdown-features.mdx @@ -59,18 +59,18 @@ Let's see how to [Create a page](./create-a-page.mdx). Regular Markdown images are supported. -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): +You can use absolute paths to reference images in the static directory (`static/img/hoist-partner-logo.png`): ```md - + ``` - + You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: ```md - + ``` ## Code Blocks diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 671bab5..6742bdc 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -5,9 +5,9 @@ import type * as Preset from '@docusaurus/preset-classic'; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) const config: Config = { - title: 'My Site', - tagline: 'Dinosaurs are cool', - favicon: 'img/favicon.ico', + title: 'HOIST HUB Docs', + tagline: 'Technical documentation for HOIST HUB implementations', + favicon: 'img/favicon.png', // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future future: { @@ -75,23 +75,17 @@ const config: Config = { respectPrefersColorScheme: true, }, navbar: { - title: 'My Site', + title: 'HOIST HUB Docs', logo: { - alt: 'My Site Logo', - src: 'img/logo.svg', + alt: 'HOIST Logo', + src: 'img/White Hoist Logo.avif', }, items: [ { type: 'docSidebar', sidebarId: 'tutorialSidebar', position: 'left', - label: 'Tutorial', - }, - {to: '/blog', label: 'Blog', position: 'left'}, - { - href: 'https://github.com/facebook/docusaurus', - label: 'GitHub', - position: 'right', + label: 'Documentation', }, ], }, @@ -99,46 +93,20 @@ const config: Config = { style: 'dark', links: [ { - title: 'Docs', + title: 'Documentation', items: [ { - label: 'Tutorial', - to: '/docs/intro', - }, - ], - }, - { - title: 'Community', - items: [ - { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', + label: 'Overview', + to: '/docs/hub-documentation/overview/purpose', }, { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', - }, - { - label: 'X', - href: 'https://x.com/docusaurus', - }, - ], - }, - { - title: 'More', - items: [ - { - label: 'Blog', - to: '/blog', - }, - { - label: 'GitHub', - href: 'https://github.com/facebook/docusaurus', + label: 'IFS Integration', + to: '/docs/hub-documentation/integration/ifs-integration', }, ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} HOIST Technology. Built with Docusaurus.`, }, prism: { theme: prismThemes.github, diff --git a/src/css/custom.css b/src/css/custom.css index 2bc6a4c..64e666f 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1,30 +1,288 @@ +/* ─── FONTS ──────────────────────────────────────────────────── */ +@font-face { + font-family: "IBM Plex Sans"; + src: url("/fonts/ibm-plex-sans/IBMPlexSans-Variable.ttf") format("truetype"); + font-weight: 100 700; + font-style: normal; + font-display: swap; +} + +@font-face { + font-family: "IBM Plex Sans"; + src: url("/fonts/ibm-plex-sans/IBMPlexSans-Italic-Variable.ttf") + format("truetype"); + font-weight: 100 700; + font-style: italic; + font-display: swap; +} + +@font-face { + font-family: "IBM Plex Mono"; + src: url("/fonts/ibm-plex-mono/IBMPlexMono-Regular.ttf") format("truetype"); + font-weight: 400; + font-style: normal; + font-display: swap; +} + +@font-face { + font-family: "IBM Plex Mono"; + src: url("/fonts/ibm-plex-mono/IBMPlexMono-Bold.ttf") format("truetype"); + font-weight: 700; + font-style: normal; + font-display: swap; +} + /** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. + * HOIST HUB Docs — Design System + * + * Single-source brand color: #465491 (hsl 228, 34%, 42%) + * All palette entries derived from this hue. + * Contrast ratios meet WCAG AA (4.5:1 text, 3:1 UI components). */ -/* You can override the default Infima variables here. */ +/* ─── DESIGN TOKENS ──────────────────────────────────────────── */ :root { - --ifm-color-primary: #2e8555; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); + /* Primary scale — hsl(228, 34%, X%) */ + --hoist-primary-950: #0e1020; + --hoist-primary-900: #1c1f3f; + --hoist-primary-800: #2a2f5e; + --hoist-primary-700: #384079; /* dark accent */ + --hoist-primary-600: #3d4a88; + --hoist-primary-500: #465491; /* BRAND */ + --hoist-primary-400: #5a69a3; + --hoist-primary-300: #7683b8; + --hoist-primary-200: #a4adcf; + --hoist-primary-100: #d1d6e9; + --hoist-primary-50: #eceef6; + + /* Neutral scale — hsl(228, 10%, X%) — same hue, desaturated */ + --hoist-neutral-950: #0d0d12; + --hoist-neutral-900: #1a1b22; + --hoist-neutral-800: #2c2d38; + --hoist-neutral-700: #3f4050; + --hoist-neutral-600: #545668; + --hoist-neutral-500: #6b6d82; + --hoist-neutral-400: #8d8fa3; + --hoist-neutral-300: #b0b2c3; + --hoist-neutral-200: #d2d4df; + --hoist-neutral-100: #e8e9f0; + --hoist-neutral-50: #f4f4f8; + + /* Semantic — success: hsl(152, 48%, 35%) — contrast safe on white */ + --hoist-success-700: #1a5c3a; + --hoist-success-500: #2a8a58; + --hoist-success-100: #d0ede0; + + /* Semantic — warning: hsl(38, 90%, 40%) */ + --hoist-warning-700: #7a4800; + --hoist-warning-500: #b86b00; + --hoist-warning-100: #fdefd6; + + /* Semantic — danger: hsl(4, 72%, 42%) */ + --hoist-danger-700: #7a1a14; + --hoist-danger-500: #c0271e; + --hoist-danger-100: #fde0de; + + /* Semantic — info: pulled from primary, lighter */ + --hoist-info-700: #2a2f5e; + --hoist-info-500: #465491; + --hoist-info-100: #d1d6e9; + + /* Typography */ + --hoist-font-sans: "IBM Plex Sans", system-ui, sans-serif; + --hoist-font-mono: "IBM Plex Mono", monospace; + + /* Spacing */ + --hoist-radius-sm: 4px; + --hoist-radius-md: 6px; + --hoist-radius-lg: 10px; + + /* Shadows */ + --hoist-shadow-sm: 0 1px 3px rgba(70, 84, 145, 0.08); + --hoist-shadow-md: 0 4px 12px rgba(70, 84, 145, 0.12); + --hoist-shadow-lg: 0 8px 24px rgba(70, 84, 145, 0.16); } -/* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme='dark'] { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); +/* ─── INFIMA OVERRIDES — LIGHT MODE ─────────────────────────── */ +:root { + --ifm-color-primary: var(--hoist-primary-500); + --ifm-color-primary-dark: var(--hoist-primary-600); + --ifm-color-primary-darker: var(--hoist-primary-700); + --ifm-color-primary-darkest: var(--hoist-primary-800); + --ifm-color-primary-light: var(--hoist-primary-400); + --ifm-color-primary-lighter: var(--hoist-primary-300); + --ifm-color-primary-lightest: var(--hoist-primary-200); + + --ifm-background-color: #ffffff; + --ifm-background-surface-color: var(--hoist-neutral-50); + --ifm-font-color-base: var(--hoist-neutral-900); + --ifm-font-color-secondary: var(--hoist-neutral-600); + + --ifm-code-font-size: 93%; + --ifm-font-family-base: var(--hoist-font-sans); + --ifm-font-family-monospace: var(--hoist-font-mono); + + --ifm-heading-color: var(--hoist-neutral-900); + --ifm-link-color: var(--hoist-primary-500); + --ifm-link-hover-color: var(--hoist-primary-700); + + --ifm-navbar-background-color: var(--hoist-primary-900); + --ifm-navbar-link-color: #ffffff; + --ifm-navbar-link-hover-color: var(--hoist-primary-300); + + --ifm-footer-background-color: var(--hoist-primary-900); + + --ifm-table-border-color: var(--hoist-neutral-200); + --ifm-table-head-background: var(--hoist-primary-50); + --ifm-table-stripe-background: var(--hoist-neutral-50); + + --ifm-hr-border-color: var(--hoist-neutral-200); + --ifm-hr-background-color: var(--hoist-neutral-200); + + --ifm-blockquote-border-color: var(--hoist-primary-300); + --ifm-blockquote-color: var(--hoist-neutral-600); + + --docusaurus-highlighted-code-line-bg: var(--hoist-primary-50); + + /* Admonitions */ + --ifm-color-info-dark: var(--hoist-info-700); + --ifm-color-info: var(--hoist-info-500); + --ifm-color-info-contrast-background: var(--hoist-info-100); + + --ifm-color-success-dark: var(--hoist-success-700); + --ifm-color-success: var(--hoist-success-500); + --ifm-color-success-contrast-background: var(--hoist-success-100); + + --ifm-color-warning-dark: var(--hoist-warning-700); + --ifm-color-warning: var(--hoist-warning-500); + --ifm-color-warning-contrast-background: var(--hoist-warning-100); + + --ifm-color-danger-dark: var(--hoist-danger-700); + --ifm-color-danger: var(--hoist-danger-500); + --ifm-color-danger-contrast-background: var(--hoist-danger-100); +} + +/* ─── INFIMA OVERRIDES — DARK MODE ──────────────────────────── */ +[data-theme="dark"] { + --ifm-color-primary: var(--hoist-primary-300); + --ifm-color-primary-dark: var(--hoist-primary-400); + --ifm-color-primary-darker: var(--hoist-primary-500); + --ifm-color-primary-darkest: var(--hoist-primary-600); + --ifm-color-primary-light: var(--hoist-primary-200); + --ifm-color-primary-lighter: var(--hoist-primary-100); + --ifm-color-primary-lightest: var(--hoist-primary-50); + + --ifm-background-color: var(--hoist-neutral-950); + --ifm-background-surface-color: var(--hoist-neutral-900); + --ifm-font-color-base: var(--hoist-neutral-100); + --ifm-font-color-secondary: var(--hoist-neutral-300); + + --ifm-heading-color: var(--hoist-neutral-50); + --ifm-link-color: var(--hoist-primary-300); + --ifm-link-hover-color: var(--hoist-primary-200); + + --ifm-navbar-background-color: var(--hoist-neutral-900); + --ifm-navbar-link-color: #ffffff; + --ifm-navbar-link-hover-color: var(--hoist-primary-300); + + --ifm-footer-background-color: var(--hoist-neutral-900); + + --ifm-table-border-color: var(--hoist-neutral-700); + --ifm-table-head-background: var(--hoist-neutral-800); + --ifm-table-stripe-background: var(--hoist-neutral-900); + + --ifm-hr-border-color: var(--hoist-neutral-700); + --ifm-hr-background-color: var(--hoist-neutral-700); + + --ifm-blockquote-border-color: var(--hoist-primary-400); + --ifm-blockquote-color: var(--hoist-neutral-300); + + --docusaurus-highlighted-code-line-bg: rgba(70, 84, 145, 0.2); + + /* Admonitions dark */ + --ifm-color-info-contrast-background: rgba(70, 84, 145, 0.15); + --ifm-color-success-contrast-background: rgba(42, 138, 88, 0.15); + --ifm-color-warning-contrast-background: rgba(184, 107, 0, 0.15); + --ifm-color-danger-contrast-background: rgba(192, 39, 30, 0.15); +} + +/* ─── GLOBAL LAYOUT ──────────────────────────────────────────── */ +.main-wrapper { + display: flex; + flex-direction: column; + flex: 1; +} + +/* ─── HOMEPAGE HERO ──────────────────────────────────────────── */ +/* (Scoped styles live in index.module.css) */ + +/* ─── FOOTER ─────────────────────────────────────────────────── */ +.footer--dark { + --ifm-footer-background-color: var(--hoist-primary-900); +} + +[data-theme="dark"] .footer--dark { + --ifm-footer-background-color: var(--hoist-neutral-900); +} + +/* ─── NAVBAR ─────────────────────────────────────────────────── */ +.navbar__logo { + padding: 0.25rem 1rem; + height: 32px; +} + +.navbar button[class*="toggleButton"] { + color: rgba(255, 255, 255, 0.75); +} + +.navbar button[class*="toggleButton"]:hover { + color: #ffffff; + background: rgba(255, 255, 255, 0.1); +} + +.navbar__link--active { + color: var(--hoist-primary-200) !important; + border-bottom: 2px solid var(--hoist-primary-300); + padding-bottom: 2px; +} + +/* ─── SIDEBAR ────────────────────────────────────────────────── */ +.menu__link--active { + font-weight: 600; +} + +.menu__link.menu__link--active:not(.menu__link--sublist):not( + .menu__link--sublist-caret + ) { + border-left: 2px solid var(--ifm-color-primary); + padding-left: calc(var(--ifm-menu-link-padding-horizontal) - 3px); + border-radius: 0; +} + +/* ─── CONTENT TYPOGRAPHY ─────────────────────────────────────── */ +.markdown h1 { + border-bottom: 2px solid var(--hoist-primary-100); + padding-bottom: 0.5rem; +} + +[data-theme="dark"] .markdown h1 { + border-bottom-color: var(--hoist-neutral-700); +} + +/* ─── TABLES ─────────────────────────────────────────────────── */ +.markdown table thead tr { + font-size: 0.8rem; + letter-spacing: 0.04em; + text-transform: uppercase; +} + +/* ─── CODE BLOCKS ────────────────────────────────────────────── */ +/* +.prism-code { +} +*/ + +/* ─── ADMONITIONS ────────────────────────────────────────────── */ +.alert { + border-left-width: 4px; } diff --git a/src/pages/index.module.css b/src/pages/index.module.css index 9f71a5d..b926ae0 100644 --- a/src/pages/index.module.css +++ b/src/pages/index.module.css @@ -1,23 +1,43 @@ -/** - * CSS files with the .module.css suffix will be treated as CSS modules - * and scoped locally. - */ - .heroBanner { - padding: 4rem 0; + display: flex; + align-items: center; + justify-content: center; + flex: 1; text-align: center; - position: relative; - overflow: hidden; + background-color: var(--hoist-primary-500); + color: #fff; +} + +[data-theme='dark'] .heroBanner { + background-color: var(--hoist-primary-900); +} + +.heroBanner :global(.hero__title), +.heroBanner :global(.hero__subtitle) { + color: #fff; +} + +.heroBanner :global(.hero__subtitle) { + margin-bottom: 2rem; + opacity: 0.85; +} + +.heroBanner :global(.button--primary) { + background-color: #fff; + border-color: #fff; + color: var(--hoist-primary-500); + font-weight: 600; + transition: background-color 0.2s, color 0.2s; +} + +.heroBanner :global(.button--primary:hover) { + background-color: transparent; + border-color: #fff; + color: #fff; } @media screen and (max-width: 996px) { .heroBanner { - padding: 2rem; + padding: 4rem 2rem; } } - -.buttons { - display: flex; - align-items: center; - justify-content: center; -} diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 2e006d1..7438810 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -1,44 +1,30 @@ import type {ReactNode} from 'react'; -import clsx from 'clsx'; import Link from '@docusaurus/Link'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; -import HomepageFeatures from '@site/src/components/HomepageFeatures'; import Heading from '@theme/Heading'; import styles from './index.module.css'; -function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); - return ( - - - - {siteConfig.title} - - {siteConfig.tagline} - - - Docusaurus Tutorial - 5min ⏱️ - - - - - ); -} - export default function Home(): ReactNode { const {siteConfig} = useDocusaurusContext(); return ( - - - - + title={siteConfig.title} + description="Technical documentation for HOIST HUB implementations"> + + + + {siteConfig.title} + + {siteConfig.tagline} + + Get Started + + + ); } diff --git a/static/fonts/ibm-plex-mono/IBMPlexMono-Bold.ttf b/static/fonts/ibm-plex-mono/IBMPlexMono-Bold.ttf new file mode 100644 index 0000000..247979c Binary files /dev/null and b/static/fonts/ibm-plex-mono/IBMPlexMono-Bold.ttf differ diff --git a/static/fonts/ibm-plex-mono/IBMPlexMono-Regular.ttf b/static/fonts/ibm-plex-mono/IBMPlexMono-Regular.ttf new file mode 100644 index 0000000..601ae94 Binary files /dev/null and b/static/fonts/ibm-plex-mono/IBMPlexMono-Regular.ttf differ diff --git a/static/fonts/ibm-plex-sans/IBMPlexSans-Italic-Variable.ttf b/static/fonts/ibm-plex-sans/IBMPlexSans-Italic-Variable.ttf new file mode 100644 index 0000000..6232aaa Binary files /dev/null and b/static/fonts/ibm-plex-sans/IBMPlexSans-Italic-Variable.ttf differ diff --git a/static/fonts/ibm-plex-sans/IBMPlexSans-Variable.ttf b/static/fonts/ibm-plex-sans/IBMPlexSans-Variable.ttf new file mode 100644 index 0000000..9add875 Binary files /dev/null and b/static/fonts/ibm-plex-sans/IBMPlexSans-Variable.ttf differ diff --git a/static/img/White Hoist Logo.avif b/static/img/White Hoist Logo.avif new file mode 100644 index 0000000..6826ed3 Binary files /dev/null and b/static/img/White Hoist Logo.avif differ diff --git a/static/img/docusaurus-social-card.jpg b/static/img/docusaurus-social-card.jpg deleted file mode 100644 index ffcb448..0000000 Binary files a/static/img/docusaurus-social-card.jpg and /dev/null differ diff --git a/static/img/docusaurus.png b/static/img/docusaurus.png deleted file mode 100644 index f458149..0000000 Binary files a/static/img/docusaurus.png and /dev/null differ diff --git a/static/img/favicon.ico b/static/img/favicon.ico deleted file mode 100644 index c01d54b..0000000 Binary files a/static/img/favicon.ico and /dev/null differ diff --git a/static/img/favicon.png b/static/img/favicon.png new file mode 100644 index 0000000..934c4f4 Binary files /dev/null and b/static/img/favicon.png differ diff --git a/static/img/hoist-partner-logo.png b/static/img/hoist-partner-logo.png new file mode 100644 index 0000000..5417f12 Binary files /dev/null and b/static/img/hoist-partner-logo.png differ diff --git a/static/img/logo.svg b/static/img/logo.svg deleted file mode 100644 index 9db6d0d..0000000 --- a/static/img/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/static/img/undraw_docusaurus_mountain.svg b/static/img/undraw_docusaurus_mountain.svg deleted file mode 100644 index af961c4..0000000 --- a/static/img/undraw_docusaurus_mountain.svg +++ /dev/null @@ -1,171 +0,0 @@ - - Easy to Use - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/static/img/undraw_docusaurus_react.svg b/static/img/undraw_docusaurus_react.svg deleted file mode 100644 index 94b5cf0..0000000 --- a/static/img/undraw_docusaurus_react.svg +++ /dev/null @@ -1,170 +0,0 @@ - - Powered by React - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/static/img/undraw_docusaurus_tree.svg b/static/img/undraw_docusaurus_tree.svg deleted file mode 100644 index d9161d3..0000000 --- a/static/img/undraw_docusaurus_tree.svg +++ /dev/null @@ -1,40 +0,0 @@ - - Focus on What Matters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
{siteConfig.tagline}