b98c83e924
* testing out a rest operations sidebar * cleanup * renamed 5 files * renamed 5 files * set redirect_from on 5 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 1 files * renamed 2 files * renamed 1 files * renamed 4 files * renamed 15 files * renamed 2 files * renamed 6 files * renamed 1 files * renamed 4 files * renamed 7 files * renamed 1 files * renamed 3 files * renamed 3 files * renamed 1 files * renamed 5 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 4 files * renamed 1 files * renamed 1 files * renamed 2 files * renamed 4 files * renamed 1 files * renamed 1 files * renamed 1 files * renamed 6 files * renamed 6 files * renamed 4 files * move files * adding more * updating to add restcontext and start of removing data/reusables/rest-reference * removed data/reusables * add a RestMiniTocItem and updating the filtering to add a subcategory so all manually added H3s are in mini tocs in addition to operations * remove console log * [WIP]: REST New Proposal Sidebar (#26471) * saving * update sidebar * remove console log * update guides and overview * import Category for category level rest pages * update undefined restOperations * update restOperationData category and subcategory levels" * minor updates * update get mini toc items function * updating REST context for sidebar * updating rest data * remove console logs * WIP: mini-toc-ing the sidebar Co-authored-by: Robert Sese <rsese@github.com> * A little cleanup * Fix first subcategory link and add some comments * updating anchor links in sidebar * adding updates * remove standalone * update product and maptopic pages using article context * add conditional link wrapper * fix sidebar toggle and versions for enterprise admin * update versions per subcategory * Highlight sidebar link for current page * Update miniToc hash links and hash change tracking * fix unique key in CollapsibleSection * Fix list markup * remove title * update permissions * Hide minitocs on landing (#26594) * hide minitocs on landing page * simplify page components and remove minitoc from sidebar for guides/overview * fix carats and category fix * remove id Co-authored-by: Grace Park <gracepark@github.com> * updating content based on versions script check with the OpenAPI * update script and content files * update script and content/rest files * update to add TocLanding * update script * update index files * add codespaces repository-secrets * remove openapi schema check script * remove minitocs at the top * add h2 about the {title} api * fix tests/unit/openapi-schema.js * Fix linting tests * fix search/topics test * fix tests/unit/pages test * update rest/reference links in components * run prettier * Update components/rest/RestReferencePage.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update components/rest/RestReferencePage.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update tests/unit/openapi-schema.js Co-authored-by: Rachael Sewell <rachmari@github.com> * updating comment location * remove dependabot override * remove path-utils current product update for rest * run linter * remove dependabot.md and remove h2 heading on restreference * update the correct product to rest for rest pages * adding comments for updates to path-utils * remove console log * REST sidebar: handle legacy v3 redirects (#26686) * Add script to handle legacy v3 REST redirects * Run the script * Handle a redirect to a redirect * Update REST test URLs * 'await' and test runs subcategory of checks * Update REST URLs for routing/developer-site-redirects tests * Update developer-redirects fixture with new REST URLs * Resolve merge conflicts * Update rest-redirects fixture with new REST URLs * Fix broken links with REST pages re-org * redirectTo could be undefined * Fix script for posterity, can't redirect paths with hashes * Remove invalid hash redirects * Typically don't need to save one-off scripts * Undo redirect changes (not necessary for handling v3 redirects) * Remove script-added redirects * Update old v3 redirects with new REST URLs * No more GHES search indexing page * 'org' not 'organization' * Update fixture data for new REST URLs * revert any content directory changes Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> * Adding test rest (#26750) * add test to check openapi schema versions and content rest frontmatter versions * update lib/redirects * fix test and add error messages * adding repository secrets * adding repository-secrets.md * Revert "update lib/redirects" This reverts commit 3aafe28265764d5bc09c0c478c8e0ca099c8fbcf. * remove lib/redirects changes and console logs * Update lib/rest/index.js Co-authored-by: Rachael Sewell <rachmari@github.com> * update unique key * Rest client side redirects (#26754) * adding tags subcategory for the rest content repos category * run prettier * bug fix for anchor scrolls" (#26892) * updating width size for rest reference page * Rest sidebar consolidation (#26862) * refactor sidebar * fix articlecontext provider issue on rest product landing page for all versions * fix a bug, create new component * revert change to create new component and fix bug Co-authored-by: Rachael Sewell <rachmari@github.com> * Set currentAnchor with a hashchange handler (#26923) * Rest sidebar design tweaks (#26807) * Rest sidebar design tweaks * tweak color to subtle * use muted color and margin for line * update to design feedback Co-authored-by: Grace Park <gracepark@github.com> * Remove cheerio from rest-collapsible (#26948) * remove cheerio from rest-collapsible * update type * adding endswith instead * use productId instead * one off edge case for secret-scanning * Reorganize subcategory and category, Update pre -> div, Add RestContext (#26950) * reorganize subcategory and category * add RestContext * update comment * update for endpoints page * add comment * move object to restcontext * remove effectiveDate in restcontext * remove width calculation for rest reference page * fix adding manual writer's minitocs to sidebar * update with feedback * update comment * update isRestReferencePage * remove page component and fix bug * adding back rest/index.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * update content/rest" * add back design tweak * update to div * update margins on rest api reference * remove page component * adding tests * separate product from rest sidebar (#27065) * separate product from rest sidebar * Use ProductCollapsibleSections for product pages * fix tests Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Grace Park <gracepark@github.com> * Rest sidebar translations (#27052) * update translations * remove general test Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com>
111 lines
3.9 KiB
TypeScript
111 lines
3.9 KiB
TypeScript
import Head from 'next/head'
|
|
|
|
import { SidebarNav } from 'components/sidebar/SidebarNav'
|
|
import { Header } from 'components/page-header/Header'
|
|
import { SmallFooter } from 'components/page-footer/SmallFooter'
|
|
import { ScrollButton } from 'components/ui/ScrollButton'
|
|
import { SupportSection } from 'components/page-footer/SupportSection'
|
|
import { DeprecationBanner } from 'components/page-header/DeprecationBanner'
|
|
import { RestBanner } from 'components/page-header/RestBanner'
|
|
import { useMainContext } from 'components/context/MainContext'
|
|
import { useTranslation } from 'components/hooks/useTranslation'
|
|
import { useRouter } from 'next/router'
|
|
|
|
type Props = { children?: React.ReactNode }
|
|
export const DefaultLayout = (props: Props) => {
|
|
const {
|
|
page,
|
|
error,
|
|
isHomepageVersion,
|
|
currentPathWithoutLanguage,
|
|
currentVersion,
|
|
currentProduct,
|
|
relativePath,
|
|
fullUrl,
|
|
status,
|
|
} = useMainContext()
|
|
const { t } = useTranslation(['errors', 'meta', 'scroll_button'])
|
|
const router = useRouter()
|
|
const metaDescription = page.introPlainText ? page.introPlainText : t('default_description')
|
|
return (
|
|
<div className="d-lg-flex">
|
|
<Head>
|
|
{error === '404' ? (
|
|
<title>{t('oops')}</title>
|
|
) : (!isHomepageVersion && page.fullTitle) ||
|
|
(currentPathWithoutLanguage.includes('enterprise-server') && page.fullTitle) ? (
|
|
<title>{page.fullTitle}</title>
|
|
) : null}
|
|
|
|
{/* For Google and Bots */}
|
|
<meta name="description" content={metaDescription} />
|
|
{page.hidden && <meta name="robots" content="noindex" />}
|
|
{page.languageVariants.map((languageVariant) => {
|
|
return (
|
|
<link
|
|
key={languageVariant.href}
|
|
rel="alternate"
|
|
hrefLang={languageVariant.hreflang}
|
|
href={`https://docs.github.com${languageVariant.href}`}
|
|
/>
|
|
)
|
|
})}
|
|
|
|
{/* For local site search indexing */}
|
|
{page.topics.length > 0 && <meta name="keywords" content={page.topics.join(',')} />}
|
|
|
|
{/* For analytics events */}
|
|
{router.locale && <meta name="path-language" content={router.locale} />}
|
|
{currentVersion && <meta name="path-version" content={currentVersion} />}
|
|
{currentProduct && <meta name="path-product" content={currentProduct.id} />}
|
|
{relativePath && (
|
|
<meta
|
|
name="path-article"
|
|
content={relativePath.replace('/index.md', '').replace('.md', '')}
|
|
/>
|
|
)}
|
|
{page.type && <meta name="page-type" content={page.type} />}
|
|
{page.documentType && <meta name="page-document-type" content={page.documentType} />}
|
|
{status && <meta name="status" content={status.toString()} />}
|
|
|
|
{/* OpenGraph data */}
|
|
{page.fullTitle && (
|
|
<>
|
|
<meta property="og:site_name" content="GitHub Docs" />
|
|
<meta property="og:title" content={page.fullTitle} />
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:url" content={fullUrl} />
|
|
<meta
|
|
property="og:image"
|
|
content="https://github.githubassets.com/images/modules/open_graph/github-logo.png"
|
|
/>
|
|
</>
|
|
)}
|
|
</Head>
|
|
<a href="#main-content" className="sr-only">
|
|
Skip to main content
|
|
</a>
|
|
<SidebarNav />
|
|
{/* Need to set an explicit height for sticky elements since we also
|
|
set overflow to auto */}
|
|
<div className="flex-column flex-1">
|
|
<Header />
|
|
<main id="main-content" style={{ scrollMarginTop: '5rem' }}>
|
|
<DeprecationBanner />
|
|
<RestBanner />
|
|
|
|
{props.children}
|
|
</main>
|
|
<footer>
|
|
<SupportSection />
|
|
<SmallFooter />
|
|
<ScrollButton
|
|
className="position-fixed bottom-0 mb-4 right-0 mr-4"
|
|
ariaLabel={t('scroll_to_top')}
|
|
/>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|