@brillout/docpress 0.0.45

package/cli.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './dist/cli/index.js'

package/dist/cli/chunk-KZROB63P.js

@@ -0,0 +1,8 @@
+// cli/configFile.ts
+import { createRequire } from "module";
+var require2 = createRequire(import.meta.url);
+var configFile = require2.resolve("../../vite.config.ts");
+
+export {
+  configFile
+};

package/dist/cli/configFile.js

@@ -0,0 +1,6 @@
+import {
+  configFile
+} from "./chunk-KZROB63P.js";
+export {
+  configFile
+};

package/dist/cli/devServer.js

@@ -0,0 +1,31 @@
+import {
+  configFile
+} from "./chunk-KZROB63P.js";
+
+// cli/devServer.ts
+import express from "express";
+import * as vite from "vite";
+import { renderPage } from "vite-plugin-ssr";
+var viteVersion = vite.version || "2.?.?";
+startServer();
+async function startServer() {
+  const app = express();
+  const viteDevServer = await vite.createServer({
+    configFile,
+    server: { middlewareMode: viteVersion.startsWith("2") ? "ssr" : true }
+  });
+  app.use(viteDevServer.middlewares);
+  app.get("*", async (req, res, next) => {
+    const pageContextInit = {
+      urlOriginal: req.originalUrl
+    };
+    const pageContext = await renderPage(pageContextInit);
+    if (!pageContext.httpResponse)
+      return next();
+    const { body, statusCode, contentType } = pageContext.httpResponse;
+    res.status(statusCode).type(contentType).send(body);
+  });
+  const port = 3e3;
+  app.listen(port);
+  console.log(`Server running at http://localhost:${port}`);
+}

package/dist/cli/index.js

@@ -0,0 +1,37 @@
+import {
+  configFile
+} from "./chunk-KZROB63P.js";
+
+// cli/index.ts
+import { build, preview } from "vite";
+import { prerender } from "vite-plugin-ssr/prerender";
+var args = process.argv.filter(Boolean).slice(2);
+var isDev = args.includes("dev");
+var isPreview = args.includes("preview");
+var isBuild = args.includes("build");
+Error.stackTraceLimit = Infinity;
+cli();
+async function cli() {
+  if (isDev) {
+    await import("./devServer.js");
+  } else if (isBuild) {
+    const commonConfig = {
+      configFile,
+      vitePluginSsr: {
+        disableAutoFullBuild: true
+      }
+    };
+    await build({ ...commonConfig });
+    await build({ ...commonConfig, build: { ssr: true } });
+    await prerender({ viteConfig: { configFile } });
+  } else if (isPreview) {
+    const server = await preview({ configFile, preview: { host: true } });
+    server.printUrls();
+  } else {
+    throw new Error(
+      `DocPress: unknown command \`$ docpress ${args.join(
+        " "
+      )}\`. Known commands: \`$ docpress dev\` and \`$ docpress preview\`.`
+    );
+  }
+}

package/index.ts

@@ -0,0 +1,2 @@
+// Needed for users using TypeScript wihout `package.json#exports` enabled (e.g. <= TS 4.6, or TS 4.7 without `"module": "node16"` / `"module": "nodenext"`)
+export * from './src/index'

package/mdx.d.ts

@@ -0,0 +1,6 @@
+declare module '*.mdx' {
+  import { FunctionComponent } from 'react'
+  const value: FunctionComponent
+  export default value
+  export const headings: { level: number; title: string; id: string; titleAddendum?: string }[]
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@brillout/docpress",
+  "version": "0.0.45",
+  "exports": {
+    ".": "./src/index.ts",
+    "./client/initFeatureList": {
+      "browser": "./src/components/features/initFeatureList.ts"
+    },
+    "./style.css": {
+      "browser": "./src/css/index.css"
+    }
+  },
+  "scripts": {
+    "// === DocPress Demo ===": "",
+    "dev": "pnpm run build && pnpm run demo:dev",
+    "preview": "pnpm run build && pnpm run demo:preview",
+    "demo:dev": "docpress dev",
+    "demo:preview": "docpress build && docpress preview",
+    "// === DocPress Source Code ===": "",
+    "build": "rm -rf dist/ && tsup ./cli/ --format esm --out-dir ./dist/cli/",
+    "reset": "git clean -Xdf && pnpm install",
+    "// === Release ===": "",
+    "prepublishOnly": "pnpm run build",
+    "release": "npm version patch && npm publish && git push && git push --tags"
+  },
+  "dependencies": {
+    "@mdx-js/mdx": "^2.0.0",
+    "@mdx-js/react": "^2.0.0",
+    "@mdx-js/rollup": "^2.0.0",
+    "@vitejs/plugin-react": "^2.0.1",
+    "balloon-css": "^1.2.0",
+    "express": "^4.17.1",
+    "rehype-pretty-code": "^0.3.2",
+    "remark-gfm": "^3.0.1",
+    "shiki": "^0.10.1",
+    "twemoji": "^13.1.0",
+    "vite": "^3.0.9",
+    "vite-plugin-ssr": "^0.4.28"
+  },
+  "peerDependencies": {
+    "react": "18",
+    "react-dom": "18"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/node": "^15.12.1",
+    "@types/react": "^17.0.44",
+    "@types/react-dom": "^17.0.6",
+    "react": "^18.1.0",
+    "react-dom": "^18.1.0",
+    "rollup": "^2.74.1",
+    "tsup": "^6.0.1",
+    "typescript": "^4.5.4",
+    "docpress": "link:"
+  },
+  "bin": {
+    "docpress": "./cli.mjs"
+  },
+  "files": [
+    "src/*",
+    "*.ts",
+    "dist/*",
+    "cli.mjs",
+    "vite.config.ts",
+    "vite.config/*"
+  ],
+  "type": "module",
+  "license": "MIT",
+  "repository": "https://github.com/brillout/docpress",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -0,0 +1,3 @@
+Doc generator of `https://vite-plugin-ssr.com` and `https://telefunc.com`.
+
+Do not use this. Consider this code private-use only (while public-readable).

package/src/MobileHeader.tsx

@@ -0,0 +1,68 @@
+import React from 'react'
+import { usePageContext } from './renderer/usePageContext'
+
+export { MobileHeader }
+
+function MobileHeader() {
+  const pageContext = usePageContext()
+  return (
+    <div
+      id="mobile-header"
+      style={{
+        height: 'var(--mobile-header-height)',
+        width: '100vw',
+        position: 'relative'
+      }}
+    >
+      <div
+        style={{
+          position: 'fixed',
+          display: 'flex',
+          alignItems: 'center',
+          background: 'white',
+          zIndex: 99,
+          top: 0,
+          left: 0,
+          height: 'var(--mobile-header-height)',
+          width: '100%',
+          borderBottom: '1px solid #ddd'
+        }}
+      >
+        <MenuToggle />
+        <a
+          href="/"
+          style={{
+            color: 'inherit',
+            display: 'flex',
+            alignItems: 'center',
+            justifyContent: 'left',
+            textDecoration: 'none'
+          }}
+        >
+          {pageContext.config.navHeaderMobile}
+        </a>
+        <div id="docsearch-mobile" />
+      </div>
+    </div>
+  )
+}
+
+function MenuToggle() {
+  return (
+    <div style={{ padding: 20, lineHeight: 0 }} id="menu-toggle">
+      <svg
+        style={{ width: 20 }}
+        className="icon"
+        xmlns="http://www.w3.org/2000/svg"
+        aria-hidden="true"
+        role="img"
+        viewBox="0 0 448 512"
+      >
+        <path
+          fill="currentColor"
+          d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"
+        ></path>
+      </svg>
+    </div>
+  )
+}

package/src/PageLayout.css

@@ -0,0 +1,32 @@
+.doc-page #page-container {
+  padding-bottom: 100px;
+}
+
+#page-wrapper {
+  flex-grow: 1;
+}
+
+.doc-page #page-wrapper {
+  --main-view-max-width: 800px;
+}
+.landing-page #page-wrapper {
+  --main-view-max-width: 1010px;
+}
+#page-wrapper {
+  max-width: calc(var(--main-view-max-width) + 80px);
+}
+#page-content {
+  box-sizing: content-box;
+  max-width: var(--main-view-max-width);
+  padding: 20px var(--main-view-padding);
+  margin: auto;
+}
+
+#page-content {
+  --main-view-padding: 20px;
+}
+@media screen and (max-width: 1139px) {
+  #page-content {
+    --main-view-padding: 10px;
+  }
+}

package/src/PageLayout.tsx

@@ -0,0 +1,43 @@
+import React from 'react'
+import { Navigation, NavigationMask } from './navigation/Navigation'
+import type { PageContextResolved } from './config/resolvePageContext'
+import { MobileHeader } from './MobileHeader'
+import { EditPageNote } from './components/EditPageNote'
+import { PageContextProvider } from './renderer/usePageContext'
+import './PageLayout.css'
+import { NavigationFullscreenButton } from './navigation/navigation-fullscreen/NavigationFullscreenButton'
+
+export { PageLayout }
+
+function PageLayout({ pageContext, children }: { pageContext: PageContextResolved; children: JSX.Element }) {
+  const { isLandingPage, pageTitle } = pageContext
+  return (
+    <React.StrictMode>
+      <PageContextProvider pageContext={pageContext}>
+        <div
+          style={{
+            display: 'flex',
+            justifyContent: 'center'
+          }}
+          className={isLandingPage ? 'landing-page' : 'doc-page'}
+        >
+          <div id="navigation-wrapper">
+            <Navigation pageContext={pageContext} />
+          </div>
+          <NavigationFullscreenButton />
+          <div id="page-wrapper">
+            <div id="page-container">
+              <MobileHeader />
+              <div id="page-content">
+                {pageTitle && <h1>{pageTitle}</h1>}
+                {children}
+                {!isLandingPage && <EditPageNote pageContext={pageContext} />}
+              </div>
+            </div>
+            <NavigationMask />
+          </div>
+        </div>
+      </PageContextProvider>
+    </React.StrictMode>
+  )
+}

package/src/algolia/DocSearch.css

@@ -0,0 +1,29 @@
+#docsearch-desktop {
+  max-width: 110px !important;
+}
+#docsearch-desktop .DocSearch-Button-Placeholder {
+  display: none;
+  padding: 0 !important;
+}
+#docsearch-desktop .DocSearch-Search-Icon {
+  margin-right: 6px !important;
+}
+#docsearch-desktop .DocSearch-Button {
+  margin-right: 3px !important;
+  margin-left: 1px !important;
+}
+
+#docsearch-mobile {
+  margin-left: auto !important;
+  padding-right: 20px !important;
+}
+
+#docsearch-mobile .DocSearch-Button {
+  margin-left: 0px !important;
+}
+
+@media screen and (max-width: 339px) {
+  #docsearch-mobile {
+    padding-right: 6px !important;
+  }
+}

package/src/algolia/DocSearch.ts

@@ -0,0 +1,37 @@
+import { escapeInject } from 'vite-plugin-ssr'
+import { PageContextResolved } from '../config/resolvePageContext'
+
+export { getDocSearchCSS }
+export { getDocSearchJS }
+
+function getDocSearchCSS(pageContext: PageContextResolved) {
+  const docSearchCSS = !pageContext.meta.algolia
+    ? ''
+    : escapeInject`
+      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@alpha" />
+    `
+  return docSearchCSS
+}
+
+function getDocSearchJS(pageContext: PageContextResolved) {
+  const docSearchJS = !pageContext.meta.algolia
+    ? ''
+    : escapeInject`
+    <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@docsearch/js@alpha"></script>
+    <script type="text/javascript">
+      docsearch({
+        appId: '${pageContext.meta.algolia.appId}',
+        apiKey: '${pageContext.meta.algolia.apiKey}',
+        indexName: '${pageContext.meta.algolia.indexName}',
+        container: '#docsearch-desktop',
+      })
+      docsearch({
+        appId: '${pageContext.meta.algolia.appId}',
+        apiKey: '${pageContext.meta.algolia.apiKey}',
+        indexName: '${pageContext.meta.algolia.indexName}',
+        container: '#docsearch-mobile',
+      })
+    </script>
+  `
+  return docSearchJS
+}

package/src/autoScrollNav.ts

@@ -0,0 +1,22 @@
+import { assert } from './utils'
+
+autoScrollNav()
+
+function autoScrollNav() {
+  const navigationEl = document.getElementById('navigation-content')
+  assert(navigationEl)
+  const href = window.location.pathname
+  const navLinks: HTMLElement[] = Array.from(navigationEl.querySelectorAll(`a[href="${href}"]`))
+  assert(navLinks.length <= 1, { navLinks, href })
+  const navLink = navLinks[0]
+  if (!navLink) return
+  navLink.scrollIntoView({
+    /*
+    behavior: 'smooth',
+    /*/
+    behavior: 'auto',
+    //*/
+    block: 'center',
+    inline: 'center'
+  })
+}

package/src/components/ContactUs.tsx

@@ -0,0 +1,19 @@
+import React from 'react'
+import { TextContactUs } from './TextContactUs'
+
+export { ContactUs }
+
+function ContactUs({ text }: { text: string }) {
+  const style: React.CSSProperties = {
+    fontSize: '1.5em',
+    textAlign: 'center',
+    margin: 'auto',
+    padding: 'var(--header-padding)',
+    maxWidth: 'var(--header-max-width)'
+  }
+  return (
+    <p style={style}>
+      {text} <TextContactUs />
+    </p>
+  )
+}

package/src/components/DocLink.tsx

@@ -0,0 +1,108 @@
+import React from 'react'
+import { getHeadings, parseTitle, Heading, HeadingWithoutLink } from '../headings'
+import { PageContextResolved } from '../config/resolvePageContext'
+import { usePageContext } from '../renderer/usePageContext'
+import { assert, assertUsage, determineSectionTitle, determineSectionUrlHash } from '../utils'
+
+export { DocLink }
+
+function DocLink({
+  href,
+  text,
+  noBreadcrumb,
+  doNotInferSectionTitle
+}: {
+  href: string
+  text?: string | JSX.Element
+  noBreadcrumb?: true
+  doNotInferSectionTitle?: true
+}) {
+  const pageContext = usePageContext()
+  return <a href={href}>{text || getTitle({ href, noBreadcrumb, pageContext, doNotInferSectionTitle })}</a>
+}
+
+function getTitle({
+  href,
+  noBreadcrumb,
+  pageContext,
+  doNotInferSectionTitle
+}: {
+  href: string
+  noBreadcrumb: true | undefined
+  pageContext: PageContextResolved
+  doNotInferSectionTitle: true | undefined
+}): string | JSX.Element {
+  let urlHash: string | null = null
+  let hrefWithoutHash: string = href
+  if (href.includes('#')) {
+    ;[hrefWithoutHash, urlHash] = href.split('#')
+  }
+  const heading = findHeading(hrefWithoutHash, pageContext)
+
+  const breadcrumbs: (string | JSX.Element)[] = []
+
+  if ('parentHeadings' in heading) {
+    breadcrumbs.push(
+      ...heading.parentHeadings
+        .slice()
+        .reverse()
+        .map(({ title }) => title)
+    )
+  }
+
+  breadcrumbs.push(heading.title)
+
+  if (urlHash) {
+    let sectionTitle: string | JSX.Element | undefined = undefined
+    if ('sectionTitles' in heading && heading.sectionTitles) {
+      heading.sectionTitles.forEach((title) => {
+        if (determineSectionUrlHash(title) === urlHash) {
+          sectionTitle = parseTitle(title)
+        }
+      })
+    }
+    if (!sectionTitle) {
+      assertUsage(
+        !doNotInferSectionTitle,
+        `Link to \`${href}\` has option \`doNotInferSectionTitle\` but \`sectionTitle\` isn't defined.`
+      )
+      sectionTitle = determineSectionTitle(href, pageContext.config.titleNormalCase)
+    }
+    breadcrumbs.push(sectionTitle)
+  }
+
+  {
+    const linkIsOnSamePage = heading.url === pageContext.urlPathname
+    if (noBreadcrumb || linkIsOnSamePage) {
+      return breadcrumbs[breadcrumbs.length - 1]
+    }
+  }
+
+  return (
+    <>
+      {breadcrumbs.map((title, i) => {
+        const seperator = i === 0 ? <></> : ' > '
+        return (
+          <React.Fragment key={i}>
+            {seperator}
+            {title}
+          </React.Fragment>
+        )
+      })}
+    </>
+  )
+}
+
+function findHeading(href: string, pageContext: PageContextResolved): Heading | HeadingWithoutLink {
+  assert(href.startsWith('/'), `\`href==='${href}'\` but should start with \`/\`.`)
+  const { headings, headingsWithoutLink } = getHeadings(pageContext.config)
+  {
+    const heading = headingsWithoutLink.find(({ url }) => href === url)
+    if (heading) {
+      return heading
+    }
+  }
+  const heading = headings.find(({ url }) => href === url)
+  assert(heading, `Could not find page \`${href}\`. Does it exist?`)
+  return heading
+}

package/src/components/EditPageNote.tsx

@@ -0,0 +1,18 @@
+import React from 'react'
+import { RepoLink } from './RepoLink'
+import { Emoji } from '../utils/Emoji'
+
+export { EditPageNote }
+
+function EditPageNote({ pageContext }: { pageContext: { urlPathname: string } }) {
+  const text = (
+    <>
+      <Emoji name="writing-hang" /> Edit this page
+    </>
+  )
+  return (
+    <div style={{ marginTop: 50 }}>
+      <RepoLink path={'/docs/pages' + pageContext.urlPathname + '.page.server.mdx'} text={text} editMode={true} />
+    </div>
+  )
+}

package/src/components/HorizontalLine.tsx

@@ -0,0 +1,20 @@
+import React from 'react'
+
+export { HorizontalLine }
+
+function HorizontalLine({ primary }: { primary?: true }) {
+  return (
+    <div className={'header-separator-line ' + (primary ? 'primary' : '')} style={{ textAlign: 'center' }}>
+      <hr
+        style={{
+          display: 'inline-block',
+          margin: 0,
+          border: 0,
+          borderTop: '1px solid #eee',
+          maxWidth: 500,
+          width: '80%'
+        }}
+      />
+    </div>
+  )
+}

package/src/components/ImportMeta.tsx

@@ -0,0 +1,11 @@
+import React from 'react'
+import { assert } from '../utils'
+
+export { ImportMeta }
+
+function ImportMeta({ prop }: { prop: string }) {
+  assert(!prop.startsWith('import'))
+  assert(!prop.startsWith('.'))
+  const text = 'imp' + 'ort.meta.' + prop
+  return <code>{text}</code>
+}

package/src/components/Info.tsx

@@ -0,0 +1,12 @@
+import React from 'react'
+import { P } from './P'
+
+export { Info }
+
+function Info({ children }: { children: React.ReactNode }) {
+  return (
+    <blockquote>
+      <P>{children}</P>
+    </blockquote>
+  )
+}

package/src/components/Link.tsx

@@ -0,0 +1,18 @@
+import React from 'react'
+import { DocLink } from './DocLink'
+import { isRepoLink, RepoLink } from './RepoLink'
+
+export { Link }
+
+function Link(props: {
+  href: string
+  text?: string | JSX.Element
+  noBreadcrumb?: true
+  doNotInferSectionTitle?: true
+}) {
+  if (isRepoLink(props.href)) {
+    return <RepoLink path={props.href} text={props.text} />
+  } else {
+    return <DocLink {...props} />
+  }
+}

package/src/components/Note.tsx

@@ -0,0 +1,31 @@
+import React from 'react'
+import { assert } from '../utils'
+
+export { Note }
+
+function Note({
+  type,
+  icon,
+  children
+}: {
+  icon: JSX.Element | string
+  type?: 'error' | 'warning'
+  children: JSX.Element
+}) {
+  assert(type === undefined || ['error', 'warning'].includes(type))
+  if (!icon) {
+    if (type === 'error') {
+      icon = ':no_entry:'
+    }
+    if (type === 'warning') {
+      icon = ':warning:'
+    }
+  }
+  return (
+    <blockquote className={type}>
+      <div style={{ marginBottom: 20 }} />
+      {icon} {children}
+      <div style={{ marginTop: 20 }} />
+    </blockquote>
+  )
+}

package/src/components/P.css

@@ -0,0 +1,8 @@
+/* Copied from Chrome's user agent stylesheet */
+div.paragraph {
+  display: block;
+  margin-block-start: 1em;
+  margin-block-end: 1em;
+  margin-inline-start: 0px;
+  margin-inline-end: 0px;
+}