Skip to content

Docs site: Fueled rebrand (headstartwp.fueled.com) #952

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.

Sign up for GitHub

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

Draft
jakemgold wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Docs site: Fueled rebrand (headstartwp.fueled.com) #952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@

## Documentation

See our [Getting Started](https://headstartwp.10up.com/docs/learn/getting-started/quick-setup/) guide.
See our [Getting Started](https://headstartwp.fueled.com/docs/learn/getting-started/quick-setup/) guide.

Visit [headstartwp.10up.com/docs](https://headstartwp.10up.com/docs) for the full documentation.
Visit [headstartwp.fueled.com/docs](https://headstartwp.fueled.com/docs) for the full documentation.

### Running docs site locally

Expand Down Expand Up @@ -40,4 +40,4 @@ This repository is a monorepo, under the `packages` there are all the tools that

## Like what you see?

<a href="http://10up.com/contact/"><img src="https://10up.com/uploads/2016/10/10up-Github-Banner.png" width="850" alt="10up" /></a>
[![Work with the 10up WordPress Practice at Fueled](https://github.com/10up/.github/blob/trunk/profile/10up-github-banner.jpg)](http://10up.com/contact/)
116 changes: 87 additions & 29 deletions docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ import { themes as prismThemes } from 'prism-react-renderer';

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'HeadstartWP Docs - Next.js Framework for WordPress',
title: 'HeadstartWP Docs - Next.js Framework for Headless WordPress',
tagline: '',
url: 'https://headstartwp.10up.com',
url: 'https://headstartwp.fueled.com',
baseUrl: '/docs',
onBrokenLinks: 'throw',
// Links into the generated /api section are unavoidably broken when
// SKIP_TYPEDOC skips generation — downgrade so local builds still pass.
onBrokenLinks: process.env.SKIP_TYPEDOC ? 'warn' : 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: '10up', // Usually your GitHub org/user name.
Expand All @@ -32,9 +34,19 @@ const config = {
({
docs: false,
blog: false,
googleTagManager: {
containerId: 'GTM-TKCGKK2',
},
// Same Google tag as the main site (Site Kit on
// headstartwp.fueled.com) — one GA4 property covers the full
// site→docs journey. Replaces the legacy 10up GTM container.
// Production-only: in dev the gtag script never loads, so the
// plugin's route-change handler would throw on every navigation.
...(process.env.NODE_ENV === 'production'
? {
gtag: {
trackingID: 'GT-WRDG786',
anonymizeIP: true,
},
}
: {}),
theme: {
customCss: './src/css/custom.css',
},
Expand All @@ -43,21 +55,29 @@ const config = {
],

plugins: [
[
'docusaurus-plugin-typedoc',
{
name: 'HeadstartWP',
out: './docs',
entryPoints: ['../packages/core', '../packages/next'],
entryPointStrategy: 'packages',
packageOptions: {
entryPoints: ['src/docs-entry-point.ts'],
},
categorizeByGroup: false,
excludeInternal: true,
readme: 'none',
},
],
// SKIP_TYPEDOC=1 skips API-reference generation for faster local
// theme/content work (it needs the monorepo packages installed and
// built). CI always runs it. Local builds still get working search,
// minus API-reference entries (see the search plugin config below).
...(process.env.SKIP_TYPEDOC
? []
: [
[
'docusaurus-plugin-typedoc',
{
name: 'HeadstartWP',
out: './docs',
entryPoints: ['../packages/core', '../packages/next'],
entryPointStrategy: 'packages',
packageOptions: {
entryPoints: ['src/docs-entry-point.ts'],
},
categorizeByGroup: false,
excludeInternal: true,
readme: 'none',
},
],
]),
[
'@docusaurus/plugin-content-docs',
{
Expand Down Expand Up @@ -97,8 +117,11 @@ const config = {
'@easyops-cn/docusaurus-search-local',
{
indexDocs: true,
docsRouteBasePath: ['learn', 'api'],
docsDir: ['documentation', 'docs'],
// Search must only reference contexts that emit an index: with
// SKIP_TYPEDOC there is no /api content, and a missing context
// index leaves the search loader hanging forever.
docsRouteBasePath: process.env.SKIP_TYPEDOC ? ['learn'] : ['learn', 'api'],
docsDir: process.env.SKIP_TYPEDOC ? ['documentation'] : ['documentation', 'docs'],
hashed: true,
},
],
Expand All @@ -121,7 +144,7 @@ const config = {
type: 'doc',
docId: 'index',
position: 'right',
label: 'Docs',
label: 'Developer Guide',
},
{
type: 'doc',
Expand All @@ -135,6 +158,12 @@ const config = {
position: 'left',
dropdownActiveClassDisabled: true,
},
{
href: 'https://headstartwp.fueled.com/',
label: 'About HeadstartWP',
position: 'right',
className: 'navbar-site-cta',
},
],
},
announcementBar: {
Expand All @@ -149,24 +178,53 @@ const config = {
style: 'light',
links: [
{
title: 'Docs',
title: 'Docs & Community',
items: [
{
label: 'Documentation',
label: 'Developer Guide',
to: '/learn',
},
{
label: 'API Reference',
to: '/api',
},
{
label: 'GitHub Discussions',
href: 'https://github.com/10up/headstartwp/discussions/',
},
],
},
{
title: 'Community',
title: 'HeadstartWP',
items: [
{
label: 'GitHub Discussions',
href: 'https://github.com/10up/headstartwp/discussions/',
label: 'Main site',
href: 'https://headstartwp.fueled.com/',
},
{
label: 'News & Updates',
href: 'https://headstartwp.fueled.com/news/',
},
{
label: 'Privacy Policy',
href: 'https://headstartwp.fueled.com/privacy-policy/',
},
],
},
{
title: 'Fueled (formerly 10up)',
items: [
{
label: 'WordPress',
href: 'https://fueled.com/wordpress/?utm_source=referral&utm_medium=Website%20Referral&utm_campaign=headstartwp.fueled.com&utm_content=docs-footer',
},
{
label: 'Hire us',
href: 'https://fueled.com/contact/?utm_source=referral&utm_medium=Website%20Referral&utm_campaign=headstartwp.fueled.com&utm_content=docs-footer-hire',
},
{
label: 'Careers',
href: 'https://fueled.com/careers/?utm_source=referral&utm_medium=Website%20Referral&utm_campaign=headstartwp.fueled.com&utm_content=docs-footer-careers',
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion docs/src/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* work well for content-centric websites.
*/

@import url("https://fonts.googleapis.com/css2?family=Cabin:ital,wght@0,400;0,500;0,600;0,700;1,400;1,500;1,600;1,700&display=swap");
@import url("https://fonts.googleapis.com/css2?family=IBM+Plex+Sans+Condensed:wght@600;700&family=IBM+Plex+Sans:ital,wght@0,400;0,500;0,600;0,700;1,400&display=swap");

@font-face {
font-family: "Virgil";
Expand Down
129 changes: 70 additions & 59 deletions docs/src/css/global-footer.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,97 +3,108 @@
border-top: 2px solid var(--ifm-color-secondary-lightest);
}

.footer-about {
background-color: var(--ifm-color-secondary-lightest);
padding: 3rem var(--ifm-spacing-horizontal);
}

.footer-about-inner {
margin: 0 auto;
max-width: var(--wide-width);
/* --- Bottom band: mirrors the headstartwp.fueled.com site footer --- */

.footer-fueled {
background-color: #323F60;
color: #fff;
font-size: 0.8rem;
font-weight: 300;
padding: 3.5rem var(--ifm-spacing-horizontal);
text-align: center;
}

.cta-careers {
vertical-align: top;
.footer-fueled a {
color: #fff;
text-decoration: underline;
}

.license {
margin-top: 20px;
.footer-fueled a:hover {
color: #ddd;
}

.license p {
.footer-fueled p {
margin: 0;
}

.license .copyright {
margin-right: 4px;
.footer-fueled .footer-links {
list-style: none;
display: flex;
flex-wrap: wrap;
justify-content: center;
gap: 4px 18px;
margin: 6px 0 0;
padding: 0;
}

@media (min-width: 900px) {
.cta-careers {
display: inline-block;
vertical-align: top;
text-align: left;
width: 48%;
}

.license {
display: inline-block;
margin-left: 2%;
text-align: right;
width: 48%;
margin-top: 0;
}
.footer-fueled .footer-links li {
opacity: 0.75;
}

.cta-careers .button {
margin-top: .5em;
background-color: var(--ifm-color-primary);
text-decoration: none;
.footer-fueled .footer-links li:hover {
opacity: 1;
}

.cta-careers .button:hover {
background-color: var(--ifm-color-primary-dark);
.footer-fueled .footer-links a {
color: inherit;
}


.footer-10up {
padding: 3rem var(--ifm-spacing-horizontal);
.footer-fueled .logo img {
width: 170px;
height: auto;
display: block;
margin: 30px auto;
}

.footer-10up .wrap {
margin: 0 auto;
max-width: var(--wide-width);
text-align: center;
.footer-fueled .social ul {
list-style: none;
display: flex;
justify-content: center;
gap: 5px;
margin: 0;
padding: 0;
}

.footer-10up .social-media svg {
width: 25px;
margin-right: 15px;
.footer-fueled .social svg {
width: 24px;
display: block;
}

.footer-10up .social-media path {
fill: var(--ifm-color-gray-600);
.footer-fueled .social path {
fill: #fff;
}

.footer-10up .social-media svg:hover path {
fill: var(--ifm-color-black);
.footer-fueled .social a:hover path {
fill: #ddd;
}

.footer-10up p {
margin: 20px 0;
.footer-fueled .sr-only {
position: absolute;
width: 1px;
height: 1px;
overflow: hidden;
clip: rect(1px, 1px, 1px, 1px);
}

@media (min-width: 900px) {
.footer-10up .wrap {
display: flex;
text-align: left;
.footer-fueled .wrap {
display: grid;
grid-template-columns: 1fr 170px 1fr;
align-items: center;
justify-content: space-between;
max-width: var(--wide-width);
margin: 0 auto;
text-align: left;
}

.footer-fueled .footer-links {
justify-content: flex-start;
}

.footer-fueled .logo img {
margin: 0 auto;
}

.footer-10up p {
margin: 0;
.footer-fueled .social ul {
justify-content: flex-end;
}
}
}
16 changes: 15 additions & 1 deletion docs/src/css/global-header.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,18 @@

html:not(.docs-wrapper) .navbar {
box-shadow: none;
}
}
/* CTA back to the main site (mirrors the site header's Get Started chip). */
.navbar-site-cta {
background: #1C1F37;
color: #fff !important;
border-radius: 2px;
padding: 8px 16px;
margin-left: 8px;
font-weight: 600;
text-decoration: none;
}

.navbar-site-cta:hover {
background: var(--ifm-color-primary);
}
Loading
Loading