Skip to content

Commit

Permalink
docs(nxdev): set document-data type on doc pages (#13508)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bcabanes
bcabanes authored Nov 30, 2022
1 parent c0bae20 commit b9b4b2b
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 69 deletions.
85 changes: 42 additions & 43 deletions nx-dev/feature-package-schema-viewer/src/lib/package-schema-list.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,55 +98,54 @@ export function PackageSchemaList({
<div className="mb-6 pt-8">
<Breadcrumbs path={router.asPath} />
</div>
<div
data-document="main"
className="mb-8 flex w-full items-center space-x-2"
>
<div className="w-full flex-grow">
<div
className="relative inline-flex rounded-md border border-slate-200 bg-slate-50 px-4 py-2 text-xs font-medium uppercase dark:border-slate-700 dark:bg-slate-800/60"
aria-hidden="true"
data-tooltip="Installable package"
>
Package
<div data-document="main">
<div className="mb-8 flex w-full items-center space-x-2">
<div className="w-full flex-grow">
<div
className="relative inline-flex rounded-md border border-slate-200 bg-slate-50 px-4 py-2 text-xs font-medium uppercase dark:border-slate-700 dark:bg-slate-800/60"
aria-hidden="true"
data-tooltip="Installable package"
>
Package
</div>
</div>
</div>
<div className="relative z-0 inline-flex flex-shrink-0">
<a
href={vm.package.githubUrl}
target="_blank"
rel="noreferrer"
aria-hidden="true"
title="See package on Github"
className="relative inline-flex items-center rounded-md border border-slate-200 bg-slate-50 px-4 py-2 text-xs font-medium uppercase dark:border-slate-700 dark:bg-slate-800/60"
>
<svg
className="mr-2 h-4 w-4"
viewBox="0 0 16 16"
fill="currentColor"
<div className="relative z-0 inline-flex flex-shrink-0">
<a
href={vm.package.githubUrl}
target="_blank"
rel="noreferrer"
aria-hidden="true"
title="See package on Github"
className="relative inline-flex items-center rounded-md border border-slate-200 bg-slate-50 px-4 py-2 text-xs font-medium uppercase dark:border-slate-700 dark:bg-slate-800/60"
>
<path
fillRule="evenodd"
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
></path>
</svg>
{vm.package.name}
</a>
<svg
className="mr-2 h-4 w-4"
viewBox="0 0 16 16"
fill="currentColor"
>
<path
fillRule="evenodd"
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
></path>
</svg>
{vm.package.name}
</a>
</div>
</div>
</div>

<Heading1 title={vm.package.name} />
<Heading1 title={vm.package.name} />

<div className="prose dark:prose-invert mb-16 max-w-none">
{vm.markdown}
</div>
<div className="prose dark:prose-invert mb-16 max-w-none">
{vm.markdown}
</div>

<PackageReference
name={vm.package.id}
guides={vm.package.guides}
executors={vm.package.executors}
generators={vm.package.generators}
/>
<PackageReference
name={vm.package.id}
guides={vm.package.guides}
executors={vm.package.executors}
generators={vm.package.generators}
/>
</div>
</div>
</div>
<Footer />
Expand Down
54 changes: 28 additions & 26 deletions nx-dev/nx-dev/pages/packages.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,33 +80,35 @@ export default function Packages(props: ReferencesProps): JSX.Element {
<div className="mb-6 pt-8">
<Breadcrumbs path={router.asPath} />
</div>
<Heading1 title={'Official Packages Reference'} />
<div data-document="main">
<Heading1 title={'Official Packages Reference'} />

<section id="packages-section" className="py-12">
<nav
aria-labelledby="package-index-navigation"
className="relative mb-24 grid grid-cols-2 gap-4 md:grid-cols-4"
>
{references.map((category: MenuItem, index, all) => (
<Link
key={'ref-' + category.id}
href={category.path as string}
className="group relative flex items-center gap-3 rounded-md border border-slate-200 bg-slate-50/40 p-4 text-sm capitalize shadow-sm transition hover:bg-slate-50 dark:border-slate-800/40 dark:bg-slate-800/60 dark:hover:bg-slate-800"
>
<img
className="h-5 w-5 object-cover opacity-75 dark:invert"
loading="lazy"
src={iconsMap[category.id]}
alt={category.name + ' illustration'}
aria-hidden="true"
/>
<span className="text-base font-medium">
{category.name}
</span>
</Link>
))}
</nav>
</section>
<section id="packages-section" className="py-12">
<nav
aria-labelledby="package-index-navigation"
className="relative mb-24 grid grid-cols-2 gap-4 md:grid-cols-4"
>
{references.map((category: MenuItem, index, all) => (
<Link
key={'ref-' + category.id}
href={category.path as string}
className="group relative flex items-center gap-3 rounded-md border border-slate-200 bg-slate-50/40 p-4 text-sm capitalize shadow-sm transition hover:bg-slate-50 dark:border-slate-800/40 dark:bg-slate-800/60 dark:hover:bg-slate-800"
>
<img
className="h-5 w-5 object-cover opacity-75 dark:invert"
loading="lazy"
src={iconsMap[category.id]}
alt={category.name + ' illustration'}
aria-hidden="true"
/>
<span className="text-base font-medium">
{category.name}
</span>
</Link>
))}
</nav>
</section>
</div>
</div>
</div>
<Footer />
Expand Down

1 comment on commit b9b4b2b

@vercel
Copy link

@vercel vercel bot commented on b9b4b2b Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx-dev-git-master-nrwl.vercel.app
nx.dev

Please sign in to comment.