@brillout/docpress 0.1.14 → 0.1.15

package/src/components/Sponsors/label.draft.svg

@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="210mm"
+   height="297mm"
+   viewBox="0 0 210 297"
+   version="1.1"
+   id="svg8"
+   inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
+   sodipodi:docname="label.draft.svg">
+  <defs
+     id="defs2" />
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.9899495"
+     inkscape:cx="461.6406"
+     inkscape:cy="96.846632"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="1366"
+     inkscape:window-height="736"
+     inkscape:window-x="0"
+     inkscape:window-y="16"
+     inkscape:window-maximized="1" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1">
+    <path
+       style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 51.40476,117.83928 13.530744,-23.435929 0.01098,0.0063 v 0"
+       id="path815"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="M 78.309972,119.26576 90.337099,96.280583 h 32.339611"
+       id="path817"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="ccc" />
+    <path
+       style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="M 71.815475,146.56548 H 85.96596 c 0.676332,-0.0209 3.30147,-0.005 3.934153,-0.83721 0.426501,-0.36462 1.272256,-1.92024 1.602106,-2.49156 l 4.177131,-7.23501 c 0,0 0.679705,-1.34341 1.817605,-2.11076 0.472523,-0.30451 3.063205,-0.4009 3.063205,-0.4009 h 13.21067"
+       id="path819"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="cccccccc" />
+    <path
+       sodipodi:nodetypes="cccccccc"
+       inkscape:connector-curvature="0"
+       id="path859"
+       d="m 145.52085,146.56548 h -14.15049 c -0.67633,-0.0209 -3.30147,-0.005 -3.93415,-0.83721 -0.4265,-0.36462 -1.27226,-1.92024 -1.60211,-2.49156 l -4.17713,-7.23501 c 0,0 -0.67971,-1.34341 -1.81761,-2.11076 -0.47252,-0.30451 -3.0632,-0.4009 -3.0632,-0.4009 h -13.21068"
+       style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+    <path
+       sodipodi:nodetypes="ccccccccc"
+       inkscape:connector-curvature="0"
+       id="path967"
+       d="m 118.49554,172.57638 -47.05804,0 h 10.748698 c 0.676332,-0.0209 3.30147,-0.005 3.934153,-0.83721 0.426501,-0.36462 1.272256,-1.92024 1.602106,-2.49156 l 4.177131,-7.23501 c 0,0 0.679705,-1.34341 1.817605,-2.11076 0.472523,-0.30451 3.063205,-0.4009 3.063205,-0.4009 l 22.282102,0"
+       style="fill:none;stroke:#000000;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+    <path
+       style="fill:#f0f0f0;stroke:none;stroke-width:0.99999994px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;fill-opacity:1"
+       d="M 365.78516 702.83789 C 365.78516 702.83789 355.99294 703.20261 354.20703 704.35352 C 349.90631 707.25374 347.33789 712.33203 347.33789 712.33203 L 331.54883 739.67578 C 330.30215 741.8351 327.10611 747.71566 325.49414 749.09375 C 323.1029 752.23911 313.18122 752.17882 310.625 752.25781 L 392.14258 752.25781 L 447.85742 752.25781 L 529.375 752.25781 C 526.81879 752.17882 516.89709 752.23911 514.50586 749.09375 C 512.89389 747.71566 509.69785 741.8351 508.45117 739.67578 L 492.66211 712.33203 C 492.66211 712.33203 490.09369 707.25374 485.79297 704.35352 C 484.00707 703.20261 474.2168 702.83789 474.2168 702.83789 L 450 702.83789 L 390 702.83789 L 365.78516 702.83789 z "
+       transform="scale(0.26458333)"
+       id="path977" />
+    <path
+       id="path982"
+       d="m 96.780656,212.41754 c 0,0 -2.590858,0.0965 -3.06338,0.40101 -1.137899,0.76735 -1.81746,2.11098 -1.81746,2.11098 l -4.177523,7.2347 c -0.32985,0.57132 -1.175469,2.12722 -1.60197,2.49184 -0.632682,0.83221 -3.257793,0.81625 -3.934126,0.83715 h 21.568193 30.61622 21.56819 c -0.67633,-0.0209 -3.30145,-0.005 -3.93413,-0.83715 -0.4265,-0.36462 -1.27212,-1.92052 -1.60197,-2.49184 l -4.17752,-7.2347 c 0,0 -0.67956,-1.34363 -1.81746,-2.11098 -0.47252,-0.30452 -3.06286,-0.40101 -3.06286,-0.40101 h -6.40736 -31.75 z"
+       style="fill:#f0f0f0;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="ccccccccccccccccc" />
+    <path
+       sodipodi:nodetypes="ccccccccccccccccc"
+       inkscape:connector-curvature="0"
+       style="fill:#f0f0f0;fill-opacity:1;stroke:none;stroke-width:0.26458332px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 96.780656,244.16756 c 0,0 -2.590858,0.0965 -3.06338,0.40101 -1.137899,0.76735 -1.81746,2.11098 -1.81746,2.11098 l -4.177523,7.2347 c -0.32985,0.57132 -1.175469,2.12722 -1.60197,2.49184 -0.632682,0.83221 -3.257793,0.81625 -3.934126,0.83715 h 21.568193 25.32455 21.56819 c -0.67633,-0.0209 -3.30145,-0.005 -3.93413,-0.83715 -0.4265,-0.36462 -1.27212,-1.92052 -1.60197,-2.49184 l -4.17752,-7.2347 c 0,0 -0.67956,-1.34363 -1.81746,-2.11098 -0.47252,-0.30452 -3.06286,-0.40101 -3.06286,-0.40101 h -6.40736 -26.45833 z"
+       id="path984" />
+    <path
+       id="path878"
+       d="m 103.72033,265.33423 c 0,0 -2.25707,0.0965 -2.66872,0.40101 -0.9913,0.76735 -1.583315,2.11098 -1.583315,2.11098 l -3.639329,7.2347 c -0.287355,0.57132 -1.024032,2.12722 -1.395586,2.49184 -0.551173,0.83221 -2.838088,0.81625 -3.427289,0.83715 h 18.789539 22.06196 18.78954 c -0.5892,-0.0209 -2.87612,-0.005 -3.42729,-0.83715 -0.37156,-0.36462 -1.10823,-1.92052 -1.39559,-2.49184 l -3.63932,-7.2347 c 0,0 -0.59202,-1.34363 -1.58332,-2.11098 -0.41164,-0.30452 -2.66827,-0.40101 -2.66827,-0.40101 h -5.58189 -23.04968 z"
+       style="fill:#f0f0f0;fill-opacity:1;stroke:none;stroke-width:0.24695262px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="ccccccccccccccccc" />
+  </g>
+</svg>

package/src/components/Sponsors.tsx

@@ -0,0 +1,242 @@
+import React from 'react'
+import iconHeart from '../icons/heart.svg'
+import { usePageContext } from '../renderer/usePageContext'
+import { assert, Emoji } from '../utils/server'
+import ccoliLogo from './Sponsors/companyLogos/ccoli.svg'
+import contraLogo from './Sponsors/companyLogos/contra.svg'
+import mfqsLogo from './Sponsors/companyLogos/mfqs.svg'
+import medalGold from './Sponsors/medalGold.svg'
+import medalSilver from './Sponsors/medalSilver.svg'
+import medalBronze from './Sponsors/medalBronze.svg'
+import labelBgImg from './Sponsors/label.svg'
+
+export { Sponsors }
+
+type Plan = 'FREE_SLOT' | 'bronze' | 'silver' | 'gold' | 'platinum'
+
+type SponsorCompany = {
+  companyName: string
+  companyLogo: string
+  website: string
+  plan: Plan
+}
+type SponsorIndividual = {
+  username: string
+}
+type Sponsor = SponsorCompany | SponsorIndividual
+
+const sponsors: Sponsor[] = [
+  {
+    companyName: 'Contra',
+    companyLogo: contraLogo,
+    plan: 'gold',
+    website: 'https://contra.com'
+  },
+  {
+    companyName: 'ccoli',
+    companyLogo: ccoliLogo,
+    plan: 'silver',
+    website: 'https://ccoli.co'
+  },
+  {
+    companyName: 'My Favorite Quilt Store',
+    companyLogo: mfqsLogo,
+    plan: 'bronze',
+    website: 'https://myfavoritequiltstore.com'
+  },
+  {
+    username: 'spacedawwwg'
+  },
+  {
+    username: 'codthing'
+  },
+  {
+    username: 'Junaidhkn'
+  },
+  {
+    username: 'zgfdev'
+  }
+]
+
+function Sponsors() {
+  const pageContext = usePageContext()
+  const { projectInfo } = pageContext.config
+  return (
+    <div style={{ textAlign: 'center', marginTop: 19 }}>
+      <a
+        className="button"
+        href="https://github.com/sponsors/brillout"
+        style={{
+          color: 'inherit',
+          display: 'inline-flex',
+          alignItems: 'center',
+          padding: '5px 10px',
+          marginBottom: 10
+        }}
+      >
+        <img src={iconHeart} height={22} /> <span style={{ marginLeft: 7, fontSize: '1.07em' }}>Sponsor</span>
+      </a>
+      <div></div>
+      <div style={{ maxWidth: 400, display: 'inline-block', marginTop: 12, marginBottom: 12 }}>
+        {projectInfo.projectNameJsx || projectInfo.projectName} is free and open source, made possible by wonderful
+        sponsors.
+      </div>
+      <div style={{ display: 'flex', flexWrap: 'wrap', justifyContent: 'center', alignItems: 'end' }}>
+        {sponsors.map((sponsor, i) => (
+          <SponsorDiv sponsor={sponsor} key={i} />
+        ))}
+      </div>
+    </div>
+  )
+}
+
+function SponsorDiv({ sponsor }: { sponsor: Sponsor }) {
+  let imgSrc: string
+  let imgAlt: string | undefined
+  let width: number
+  let height: number
+  let website: string
+  let padding: number
+  let backgroundColor = '#f0f0f0'
+  let label: null | JSX.Element = null
+  if ('username' in sponsor) {
+    website = `https://github.com/${sponsor.username}`
+    imgSrc = `https://github.com/${sponsor.username}.png?size=30`
+    width = 30
+    height = 30
+    padding = 0
+    backgroundColor = 'none'
+  } else {
+    imgSrc = sponsor.companyLogo
+    website = sponsor.website
+    const size = getSize(sponsor.plan)
+    width = size.width
+    height = size.height
+    padding = size.padding
+    imgAlt = sponsor.companyName
+    label = <Label sponsor={sponsor} />
+  }
+  const marginWidth = 5
+  return (
+    <a
+      href={website}
+      style={{
+        margin: `10px ${marginWidth}px`
+      }}
+    >
+      {label}
+      <div
+        style={{
+          backgroundColor,
+          borderRadius: 7,
+          overflow: 'hidden',
+          width,
+          maxWidth: `calc(100vw - 2 * var(--main-view-padding) - 2 * ${marginWidth}px)`,
+          height,
+          display: 'flex',
+          alignItems: 'center',
+          flexDirection: 'column',
+          justifyContent: 'center'
+        }}
+      >
+        <img
+          style={{ width: `calc(100% - ${padding}px)`, height: height - padding, zIndex: 2 }}
+          src={imgSrc}
+          alt={imgAlt}
+        />
+      </div>
+    </a>
+  )
+}
+
+function Label({ sponsor }: { sponsor: Sponsor }) {
+  assert(!('username' in sponsor))
+  const labelBg = getLabelBg(sponsor)
+  const labelIcon = getLabelIcon(sponsor)
+  const labelText = getLabelText(sponsor)
+  return (
+    <div
+      style={{
+        top: 0,
+        display: 'flex',
+        justifyContent: 'center',
+        alignItems: 'center',
+        position: 'relative',
+        paddingBottom: 1
+      }}
+    >
+      {labelBg}
+      {labelIcon}
+      {labelText}
+    </div>
+  )
+}
+
+function getLabelBg(sponsor: SponsorCompany) {
+  const height = sponsor.plan === 'platinum' ? 32 : 24
+  return <img src={labelBgImg} style={{ height, position: 'absolute', bottom: 0, zIndex: -1 }} />
+}
+
+function getLabelText(sponsor: SponsorCompany) {
+  if (sponsor.plan === 'platinum') {
+    return <></>
+  }
+  const letterSpacing = ['bronze', 'silver', 'gold'].includes(sponsor.plan) ? 1 : undefined
+  return (
+    <>
+      {' '}
+      <span
+        style={{
+          zIndex: 1,
+          fontSize: '0.82em',
+          position: 'relative',
+          top: 0,
+          fontWeight: 500,
+          color: '#666',
+          letterSpacing
+        }}
+      >
+        {capitalizeFirstLetter(sponsor.plan)}
+      </span>
+    </>
+  )
+}
+
+function getLabelIcon(sponsor: SponsorCompany) {
+  let medalSrc: string
+  if (sponsor.plan === 'platinum') {
+    return <Emoji name="trophy" style={{ fontSize: '1.3em' }} />
+  } else if (sponsor.plan === 'gold') {
+    medalSrc = medalGold
+  } else if (sponsor.plan === 'silver') {
+    medalSrc = medalSilver
+  } else if (sponsor.plan === 'bronze') {
+    medalSrc = medalBronze
+  } else {
+    assert(false)
+  }
+  return <img src={medalSrc} style={{ height: 15, zIndex: 1, marginRight: 5 }} />
+}
+
+function getSize(plan: Plan) {
+  if (plan === 'platinum') {
+    assert(false)
+  }
+  if (plan === 'gold') {
+    return { width: 400, height: 150, padding: 95 }
+  }
+  if (plan === 'silver') {
+    return { width: 300, height: 100, padding: 45 }
+  }
+  if (plan === 'bronze') {
+    return { width: 200, height: 70, padding: 30 }
+  }
+  if (plan === 'FREE_SLOT') {
+    return { width: 150, height: 40, padding: 15 }
+  }
+  assert(false)
+}
+
+function capitalizeFirstLetter(word: string): string {
+  return word[0].toUpperCase() + word.slice(1)
+}

package/{dist → src}/components/features/FeatureList.css

@@ -1,4 +1,3 @@
-/* src/components/features/FeatureList.css */
 @media screen and (min-width: 840px) {
   .features-row {
     display: grid;
@@ -17,6 +16,7 @@
     grid-column: 1 / 3;
   }
 }
+
 @media screen and (min-width: 840px) {
   .features-row.single-column .feature {
     grid-column: 1 / span 2 !important;
@@ -25,11 +25,13 @@
     margin: auto !important;
   }
 }
+
 #features {
   margin: auto;
   margin-top: 0;
   max-width: 1080px;
 }
+
 #features summary p {
   margin: 10px 0;
 }
@@ -44,6 +46,7 @@
 .learn-more h3:first-of-type {
   margin-top: 15px;
 }
+
 .learn-more {
   border: var(--border-width) solid var(--border-color);
   padding: 10px 8px;
@@ -95,6 +98,8 @@ aside.learn-more.right-side {
   border-bottom: 0 !important;
   z-index: 1;
 }
+
+/* Hide top border of .learn-more */
 .learn-more {
   position: relative;
   top: calc(-1 * var(--border-width));
@@ -103,10 +108,10 @@ aside.learn-more.right-side {
   position: relative;
   z-index: 1;
 }
+
 .feature .chevron {
   transition: filter 0.3s ease-in-out, transform 0.3s ease-in-out !important;
 }
 .feature.selected .chevron {
   transform: rotate(180deg);
 }
-/*# sourceMappingURL=FeatureList.css.map */

package/src/components/features/FeatureList.tsx

@@ -0,0 +1,114 @@
+import React from 'react'
+import './FeatureList.css'
+import iconChevron from './chevron.svg'
+
+export { FeatureList }
+
+type FeatureProps = {
+  title: React.ReactNode
+  desc: React.ReactNode
+  learnMore?: React.ReactNode
+  isSecondaryFeature?: true
+}
+
+function FeatureList({ features }: { features: FeatureProps[] }) {
+  const numberOfFeatures = features.length
+  const numberOfRows = Math.ceil(numberOfFeatures / 2)
+  return (
+    <div id="features">
+      {Array.from({ length: numberOfRows }, (_, i) => {
+        const feature1Id = 2 * i + 0
+        const feature2Id = 2 * i + 1
+        const feature1 = features[feature1Id]
+        const feature2 = features[feature2Id]
+        const className = ['features-row', feature2 ? '' : 'single-column'].filter(Boolean).join(' ')
+        return (
+          <div className={className} key={i}>
+            <Feature {...{ ...feature1, featureId: feature1Id }} />
+            {feature2 && <Feature {...{ ...feature2, featureId: feature2Id }} />}
+          </div>
+        )
+      })}
+    </div>
+  )
+}
+
+function Feature({ title, desc, learnMore, isSecondaryFeature, featureId }: FeatureProps & { featureId: number }) {
+  const name = `feature-${featureId}`
+  const rightSide = featureId % 2 === 1
+  return (
+    <>
+      <FeatureHead name={name} hasLearnMore={!!learnMore} isSecondaryFeature={isSecondaryFeature}>
+        {' '}
+        <h2>{title}</h2>
+        {desc}
+      </FeatureHead>
+      {!!learnMore && (
+        <LearnMore name={name} rightSide={rightSide}>
+          {learnMore}
+        </LearnMore>
+      )}
+    </>
+  )
+}
+
+function FeatureHead({
+  children,
+  name,
+  hasLearnMore,
+  isSecondaryFeature,
+  className = ''
+}: {
+  className?: string
+  name?: string
+  hasLearnMore?: boolean
+  isSecondaryFeature?: true
+  children: any
+}) {
+  return (
+    <summary
+      className={[
+        className,
+        'feature',
+        'colorize-on-hover',
+        hasLearnMore && 'has-learn-more',
+        isSecondaryFeature && 'secondary-feature'
+      ]
+        .filter(Boolean)
+        .join(' ')}
+      id={name && `feature-${name}`}
+      style={{ cursor: (hasLearnMore && 'pointer') || undefined }}
+    >
+      {children}
+      {hasLearnMore && (
+        <div style={{ textAlign: 'center', marginTop: '1em' }}>
+          <button
+            type="button"
+            style={{
+              textAlign: 'center',
+              padding: '0 7px',
+              paddingTop: 3,
+              paddingBottom: 1,
+              display: 'inline-block',
+              fontSize: '10px',
+              textTransform: 'uppercase',
+              letterSpacing: '1px',
+              fontWeight: 600
+            }}
+          >
+            <span className="decolorize-5">Learn more</span>
+            <br />
+            <img className="decolorize-4 chevron" src={iconChevron} height="7" style={{ marginTop: 2 }} />
+          </button>
+        </div>
+      )}
+    </summary>
+  )
+}
+function LearnMore({ children, name, rightSide }: { name: string; children: any; rightSide: boolean }) {
+  return (
+    <aside className={'learn-more ' + (rightSide ? 'right-side' : '')} id={`learn-more-${name}`}>
+      {children}
+    </aside>
+  )
+}

package/src/components/features/initFeatureList.ts

@@ -0,0 +1,66 @@
+import { assert } from '../../utils/client'
+
+addTwitterWidgets()
+addFeatureClickHandlers()
+window.__docpress_hydrationFinished = true
+
+function addTwitterWidgets() {
+  loadScript('https://platform.twitter.com/widgets.js')
+}
+
+function addFeatureClickHandlers() {
+  const featureEls: HTMLElement[] = Array.from(
+    document.getElementById('features')!.querySelectorAll('.feature.has-learn-more')
+  )
+  featureEls.forEach((featureEl) => {
+    featureEl.onclick = () => {
+      expandLearnMore(featureEl)
+    }
+  })
+}
+
+function expandLearnMore(featureEl: HTMLElement) {
+  const featureId = featureEl.id
+  assert(featureId.startsWith('feature-'), { featureId })
+  const featureName = featureId.slice('feature-'.length)
+
+  const selectedClass = 'selected'
+  const learnId = 'learn-more-' + featureName
+  const learnEl = document.getElementById(learnId)
+  assert(learnEl, { learnId })
+
+  const isExpanded = featureEl.classList.contains(selectedClass)
+
+  if (!isExpanded) {
+    const rowEl = featureEl.parentNode as HTMLElement
+    if (getComputedStyle(rowEl, 'display') === 'grid') {
+      ;[
+        ...(rowEl.querySelectorAll('.learn-more') as any as HTMLElement[]),
+        ...(rowEl.querySelectorAll('.feature') as any as HTMLElement[])
+      ].forEach((el) => {
+        el.classList.remove(selectedClass)
+      })
+    }
+  }
+
+  ;[featureEl, learnEl].forEach((el) => {
+    el.classList.toggle(selectedClass)
+  })
+}
+
+function loadScript(scriptUrl: string): void {
+  assert(scriptUrl.startsWith('https://'))
+  const scriptEl = document.createElement('script')
+  scriptEl.src = scriptUrl
+  scriptEl.async = true
+  scriptEl.setAttribute('charset', 'utf-8')
+  document.getElementsByTagName('head')[0].appendChild(scriptEl)
+}
+
+function getComputedStyle(el: HTMLElement, styleProp: string) {
+  return window.document.defaultView!.getComputedStyle(el).getPropertyValue(styleProp)
+}
+
+declare global {
+  var __docpress_hydrationFinished: undefined | true
+}

package/src/components/index.ts

@@ -0,0 +1,13 @@
+export * from '../utils/Emoji'
+export * from './Link'
+export * from './DocLink'
+export * from './RepoLink'
+export * from './P'
+export * from './Info'
+export * from './ReadingRecommendation'
+export * from './Note'
+export * from './ImportMeta'
+export * from './features/FeatureList'
+export * from './HorizontalLine'
+export * from './Sponsors'
+export * from './CodeBlock'

package/src/config/Config.ts

@@ -0,0 +1,30 @@
+export type { Config }
+
+import type { HeadingDefinition, HeadingWithoutLink } from '../headings'
+
+type Config = {
+  projectInfo: {
+    githubRepository: string
+    githubIssues: string
+    projectName: string
+    projectNameJsx?: JSX.Element
+    projectVersion: string
+    discordInvite: string
+    twitterProfile: string
+  }
+  faviconUrl: string
+  algolia: null | {
+    appId: string
+    apiKey: string
+    indexName: string
+  }
+  headings: HeadingDefinition[]
+  headingsWithoutLink: HeadingWithoutLink[]
+  navHeaderMobile: React.ReactNode
+  navHeader: React.ReactNode
+  titleNormalCase: boolean
+  tagline: string
+  websiteUrl: string
+  bannerUrl?: string
+  twitterHandle: string
+}

package/src/config/getConfig.ts

@@ -0,0 +1,18 @@
+export { getConfig }
+import { assert, assertUsage } from '../utils/server'
+import { Config } from './Config'
+
+function getConfig(): Config {
+  // We use `@ts-ignore` because the DocPress user most likely didn't add `vite/client` in his `tsconfig.json`.
+  // @ts-ignore
+  const globResult = import.meta.glob('/**/docpress.config.*([a-zA-Z0-9])', { eager: true })
+  const files = Object.keys(globResult)
+  assertUsage(files.length >= 1, 'No DocPress config file found `docpress.config.(js|ts|tsx|...)`')
+  assertUsage(
+    files.length === 1,
+    `Found multiple \`docpress.config.js\` files: ${files.map((f) => `\`${f}\``).join(', ')}. Define only one instead.`
+  )
+  const config = (Object.values(globResult)[0] as any).default as Config
+  assert(config)
+  return config
+}