@brillout/docpress 0.0.45

package/src/config/resolvePageContext.ts

@@ -0,0 +1,156 @@
+import { assert, jsxToTextContent, objectAssign } from '../utils'
+import { getHeadings, HeadingWithoutLink, parseTitle } from '../headings'
+import type { Heading } from '../headings'
+import type { PageContextBuiltIn } from 'vite-plugin-ssr'
+import type { MarkdownHeading } from '../../vite.config/markdownHeadings'
+import type { Config } from './Config'
+import { getConfig } from './getConfig'
+
+export { resolvePageContext }
+export type { PageContextOriginal }
+export type { PageContextResolved }
+export type { Heading }
+
+type ReactComponent = () => JSX.Element
+type Exports = {
+  headings?: MarkdownHeading[]
+}
+type PageContextOriginal = PageContextBuiltIn & {
+  Page: ReactComponent
+  exports: Exports
+}
+type PageContextResolved = ReturnType<typeof resolvePageContext>
+
+function resolvePageContext(pageContext: PageContextOriginal) {
+  const config = getConfig()
+  const { headings, headingsWithoutLink } = getHeadings(config)
+  const activeHeading = findActiveHeading(headings, headingsWithoutLink, pageContext)
+  const headingsWithSubHeadings = getHeadingsWithSubHeadings(headings, pageContext, activeHeading)
+  const { title, isLandingPage, pageTitle, isDetachedPage } = getMetaData(
+    headingsWithoutLink,
+    activeHeading,
+    pageContext,
+    config
+  )
+  const { faviconUrl, algolia, tagline, twitterHandle, bannerUrl, websiteUrl } = config
+  const pageContextResolved = {}
+  objectAssign(pageContextResolved, {
+    ...pageContext,
+    meta: {
+      title,
+      faviconUrl,
+      twitterHandle, bannerUrl,
+      websiteUrl,
+      tagline,
+      algolia
+    },
+    headings,
+    headingsWithSubHeadings,
+    isLandingPage,
+    isDetachedPage,
+    pageTitle,
+    config
+  })
+  return pageContextResolved
+}
+
+function getMetaData(
+  headingsWithoutLink: HeadingWithoutLink[],
+  activeHeading: Heading | null,
+  pageContext: { urlOriginal: string; exports: Exports },
+  config: Config
+) {
+  const url = pageContext.urlOriginal
+
+  let title: string
+  let pageTitle: string | JSX.Element | null
+  let isDetachedPage: boolean
+  if (activeHeading) {
+    title = activeHeading.titleDocument || jsxToTextContent(activeHeading.title)
+    pageTitle = activeHeading.title
+    isDetachedPage = false
+  } else {
+    pageTitle = headingsWithoutLink.find((h) => h.url === url)!.title
+    title = jsxToTextContent(pageTitle)
+    isDetachedPage = true
+  }
+
+  const isLandingPage = url === '/'
+  if (!isLandingPage) {
+    title += ' | ' + config.projectInfo.projectName
+  }
+
+  if (isLandingPage) {
+    pageTitle = null
+  }
+
+  return { title, isLandingPage, pageTitle, isDetachedPage }
+}
+
+function findActiveHeading(
+  headings: Heading[],
+  headingsWithoutLink: HeadingWithoutLink[],
+  pageContext: { urlOriginal: string; exports: Exports }
+): Heading | null {
+  let activeHeading: Heading | null = null
+  assert(pageContext.urlOriginal)
+  const pageUrl = pageContext.urlOriginal
+  headings.forEach((heading) => {
+    if (heading.url === pageUrl) {
+      activeHeading = heading
+      assert(heading.level === 2, { pageUrl, heading })
+    }
+  })
+  const debugInfo = {
+    msg: 'Heading not found for url: ' + pageUrl,
+    urls: headings.map((h) => h.url),
+    url: pageUrl
+  }
+  assert(activeHeading || headingsWithoutLink.find(({ url }) => pageUrl === url), debugInfo)
+  return activeHeading
+}
+
+function getHeadingsWithSubHeadings(
+  headings: Heading[],
+  pageContext: { exports: Exports; urlOriginal: string },
+  activeHeading: Heading | null
+): Heading[] {
+  const headingsWithSubHeadings = headings.slice()
+  if (activeHeading === null) return headingsWithSubHeadings
+  const activeHeadingIdx = headingsWithSubHeadings.indexOf(activeHeading)
+  assert(activeHeadingIdx >= 0)
+  const pageHeadings = pageContext.exports.headings || []
+  pageHeadings.forEach((pageHeading, i) => {
+    const title = parseTitle(pageHeading.title)
+    const url = '#' + pageHeading.id
+    assert(
+      pageHeading.headingLevel !== 3,
+      'Wrong page heading level `' +
+        pageHeading.headingLevel +
+        '` (it should be `<h2>`) for sub-heading `' +
+        pageHeading.title +
+        '` of page `' +
+        pageContext.urlOriginal +
+        '`.'
+    )
+    if (pageHeading.headingLevel === 2) {
+      const heading: Heading = {
+        url,
+        title,
+        parentHeadings: [activeHeading, ...activeHeading.parentHeadings],
+        titleInNav: title,
+        level: 3
+      }
+      headingsWithSubHeadings.splice(activeHeadingIdx + 1 + i, 0, heading)
+    }
+  })
+
+  if (activeHeading?.sectionTitles) {
+    activeHeading.sectionTitles.forEach((sectionTitle) => {
+      const pageHeadingTitles = pageHeadings.map((h) => h.title)
+      assert(pageHeadingTitles.includes(sectionTitle), { pageHeadingTitles, sectionTitle })
+    })
+  }
+
+  return headingsWithSubHeadings
+}

package/src/css/button.css

@@ -0,0 +1,7 @@
+button,
+a.button {
+  background-color: #fafafa;
+  border: 1px solid #aaa;
+  border-radius: 5px;
+  cursor: pointer;
+}

package/src/css/code/block.css

@@ -0,0 +1,36 @@
+pre > code {
+  padding: 16px !important;
+}
+@media screen and (max-width: 900px) {
+  pre > code {
+    font-size: 0.7em;
+  }
+}
+pre {
+  display: grid;
+}
+pre > code {
+  padding-right: 0px !important;
+  overflow-x: auto;
+}
+
+@media screen and (max-width: 1139px) {
+  pre > code {
+    font-size: 0.95em;
+  }
+}
+@media screen and (max-width: 1040px) {
+  pre > code {
+    font-size: 0.8em;
+  }
+}
+@media screen and (max-width: 940px) {
+  pre > code {
+    font-size: 0.7em;
+  }
+}
+
+pre > code {
+  display: reset;
+  word-break: reset;
+}

package/src/css/code/inline.css

@@ -0,0 +1,27 @@
+code {
+  padding: 2px 5px;
+}
+
+/*
+ * Line breaks in `<code>`:
+ *  - Avoid them on desktop
+ *  - Allow them on mobile
+ *  - Allo them for `<code long>`
+ */
+code {
+  display: inline-block;
+}
+@media screen and (max-width: 500px) {
+  code {
+    word-break: break-word;
+    display: inline;
+  }
+}
+.inline-code-break code {
+  display: inline;
+  word-break: break-word;
+}
+code.long {
+  word-break: break-word;
+  display: inline;
+}

package/src/css/code.css

@@ -0,0 +1,20 @@
+@import './code/inline.css';
+@import './code/block.css';
+
+code {
+  /*
+  background-color: #f4f4f4;
+  0.043137255 = 1 - (#f4 / #ff)
+  */
+  background-color: rgba(0, 0, 0, 0.043137255);
+  border-radius: 4px;
+}
+
+/* Inline */
+code {
+  font-size: 1.1em;
+}
+/* Block */
+pre > code {
+  font-size: 1em;
+}

package/src/css/colorize-on-hover.css

@@ -0,0 +1,29 @@
+.colorize-on-hover,
+.colorize-on-hover [class^='decolorize-'],
+.colorize-on-hover [class*=' decolorize-'] {
+  transition: filter 0.3s ease-in-out;
+}
+.colorize-on-hover:hover,
+.colorize-on-hover:hover [class^='decolorize-'],
+.colorize-on-hover:hover [class*=' decolorize-'] {
+  filter: grayscale(0) opacity(1) !important;
+}
+
+.decolorize-7 {
+  filter: grayscale(1) opacity(0.7);
+}
+.decolorize-6 {
+  filter: grayscale(1) opacity(0.6);
+}
+.decolorize-5 {
+  filter: grayscale(1) opacity(0.5);
+}
+.decolorize-4 {
+  filter: grayscale(1) opacity(0.4);
+}
+
+/*
+ * Twitter opacity(0.7): #ababab > #868686
+ * == Following computation does NOT work ==
+ * Discord opacity(0.7): #6c6c6c > (0.7 * (#fff - #ababab) = #868686 = x * (#fff - #6c6c6c) <=> x = 0.7 * ((#fff - #ababab) / (#fff - #6c6c6c)) = 0.7 * ((255 - 171) / (255 - 108)) = 0.4)
+ */

package/src/css/font.css

@@ -0,0 +1,19 @@
+body {
+  font-family: 'Inter';
+}
+button {
+  font-family: inherit;
+}
+body {
+  --color-text: #323d48;
+  color: var(--color-text);
+  line-height: 1.5;
+}
+
+@font-face {
+  font-family: 'Inter';
+  font-weight: 100 900;
+  font-stretch: 75% 125%;
+  font-style: oblique 0deg 12deg;
+  src: url('./Inter-Var.ttf') format('truetype-variations');
+}

package/src/css/heading.css

@@ -0,0 +1,25 @@
+.doc-page h2 {
+  margin-top: 50px;
+  margin-bottom: 16px;
+}
+.doc-page h2[id] {
+  cursor: pointer;
+  position: relative;
+  padding-left: 20px;
+  margin-left: -20px;
+}
+.doc-page h2[id]:hover::before {
+  content: '#';
+  position: absolute;
+  left: calc(-1 * (0.75em - 20px));
+  color: #aaa;
+}
+
+.doc-page h1 + h2 {
+  margin-top: 0;
+}
+
+.doc-page h4 {
+  margin-top: 32px;
+  margin-bottom: 16px;
+}

package/src/css/index.css

@@ -0,0 +1,10 @@
+@import './reset.css';
+@import './colorize-on-hover.css';
+@import './heading.css';
+@import './button.css';
+@import './link.css';
+@import './font.css';
+@import './code.css';
+@import './note.css';
+@import './table.css';
+@import './tooltip.css';

package/src/css/link.css

@@ -0,0 +1,17 @@
+/*
+:root {
+  --link-color: #4747ff;
+}
+*/
+
+a {
+  /*
+  color: inherit;
+  color: var(--link-color);
+  */
+  color: #4747ff;
+  text-decoration: none;
+}
+a > button {
+  color: var(--color-text);
+}

package/src/css/note.css

@@ -0,0 +1,26 @@
+blockquote {
+  --color: 0, 0, 0;
+  --color-strengh-bg: 0.7;
+  --color-strengh-border: 1.5;
+  border-left: 8px solid rgba(var(--color), calc(0.06 * var(--color-strengh-border)));
+  background-color: rgba(var(--color), calc(0.03 * var(--color-strengh-bg)));
+  margin-left: 0;
+  padding: 4px 16px;
+}
+blockquote.error {
+  --color-strengh-bg: 1.7;
+  --color-strengh-border: 6;
+  --color: 190, 25, 49;
+}
+blockquote.warning {
+  --color-strengh-bg: 4;
+  --color-strengh-border: 8;
+  --color: 255, 204, 50;
+}
+blockquote > p:first-child::before,
+/* blockquote > p:first-of-type::before, */
+blockquote > div.paragraph:first-child::before {
+  font-family: emoji;
+  content: 'ℹ️';
+  margin-right: 4px;
+}

package/src/css/reset.css

@@ -0,0 +1,12 @@
+* {
+  box-sizing: border-box;
+}
+body {
+  margin: 0;
+}
+
+/* Avoid tweet embeds to overflow the body width.
+ * Settings `overflow: hidden` to a container doesn't work (This is a CSS bug?) */
+iframe {
+  max-width: 100%;
+}

package/src/css/table.css

@@ -0,0 +1,14 @@
+table th {
+  background-color: #f7f7f7;
+}
+table {
+  border-collapse: collapse;
+}
+table td,
+table th {
+  padding: 8px;
+  border: 1px solid #ccc;
+}
+table th {
+  text-align: left;
+}

package/src/css/tooltip.css

@@ -0,0 +1,11 @@
+@import 'balloon-css';
+
+:root {
+  --balloon-color: #444;
+  --balloon-move: 2px;
+  --balloon-font-size: 14px;
+  --balloon-border-radius: 5px;
+}
+[aria-label][data-balloon-pos]:after {
+  font-family: 'Inter';
+}

package/src/headings.ts

@@ -0,0 +1,206 @@
+import React from 'react'
+import { assert } from './utils'
+import { Emoji, EmojiName } from './utils/Emoji'
+
+export { getHeadings }
+export { parseTitle }
+
+export type Heading = Omit<HeadingDefinition, 'title' | 'titleInNav'> & {
+  title: JSX.Element
+  titleInNav: JSX.Element
+  parentHeadings: Heading[]
+  // Not sure why this is needed
+  isListTitle?: true
+  sectionTitles?: string[]
+}
+export type HeadingWithoutLink = {
+  url: string
+  title: string | JSX.Element
+}
+export type HeadingDefinition = HeadingBase &
+  (
+    | ({ level: 1; titleEmoji: EmojiName } & HeadingAbstract)
+    | ({ level: 4 } & HeadingAbstract)
+    | {
+        level: 2
+        isListTitle?: true
+        sectionTitles?: string[]
+        url: string
+      }
+    | {
+        level: 3
+        url: string
+      }
+  )
+type HeadingBase = {
+  title: string
+  level: number
+  url?: string
+  titleDocument?: string
+  titleInNav?: string
+  // titleSize?: string
+}
+type HeadingAbstract = {
+  url?: undefined
+  titleDocument?: undefined
+  titleInNav?: undefined
+}
+
+function getHeadings(config: { headings: HeadingDefinition[]; headingsWithoutLink: HeadingWithoutLink[] }): {
+  headings: Heading[]
+  headingsWithoutLink: HeadingWithoutLink[]
+} {
+  const headingsWithoutParent: Omit<Heading, 'parentHeadings'>[] = config.headings.map((heading: HeadingDefinition) => {
+    const titleProcessed: JSX.Element = parseTitle(heading.title)
+
+    const titleInNav = heading.titleInNav || heading.title
+    let titleInNavProcessed: JSX.Element
+    if ('isListTitle' in heading) {
+      assert(heading.isListTitle === true)
+      let titleParsed: JSX.Element = parseTitle(titleInNav)
+      // if (heading.titleSize) {
+      //   titleParsed = React.createElement('span', { style: { fontSize: heading.titleSize } }, titleParsed)
+      // }
+      titleInNavProcessed = React.createElement(React.Fragment, {}, [getListPrefix(), titleParsed])
+    } else {
+      titleInNavProcessed = parseTitle(titleInNav)
+    }
+    if ('titleEmoji' in heading) {
+      assert(heading.titleEmoji)
+      titleInNavProcessed = withEmoji(heading.titleEmoji, titleInNavProcessed)
+    }
+
+    const headingProcessed: Omit<Heading, 'parentHeadings'> = {
+      ...heading,
+      title: titleProcessed,
+      titleInNav: titleInNavProcessed
+    }
+    return headingProcessed
+  })
+
+  const headings: Heading[] = []
+  headingsWithoutParent.forEach((heading) => {
+    const parentHeadings = findParentHeadings(heading, headings)
+    headings.push({ ...heading, parentHeadings })
+  })
+
+  const headingsWithoutLink = config.headingsWithoutLink.map((headingsWithoutLink) => {
+    const { url, title } = headingsWithoutLink
+    assert(
+      headings.find((heading) => heading.url === url) === undefined,
+      `remove ${headingsWithoutLink.url} from headingsWithoutLink`
+    )
+    const titleProcessed = typeof title === 'string' ? parseTitle(title) : title
+    return {
+      ...headingsWithoutLink,
+      title: titleProcessed
+    }
+  })
+
+  assertHeadingsUrl([...headings, ...headingsWithoutLink])
+  return { headings, headingsWithoutLink }
+}
+
+function findParentHeadings(heading: Omit<Heading, 'parentHeadings'>, headings: Heading[]) {
+  const parentHeadings: Heading[] = []
+  let levelCurrent = heading.level
+  let listTitleParentFound = false
+  headings
+    .slice()
+    .reverse()
+    .forEach((parentCandidate) => {
+      let isListTitleParent = false
+      if (
+        !listTitleParentFound &&
+        levelCurrent === heading.level &&
+        parentCandidate.level === heading.level &&
+        !parentCandidate.isListTitle &&
+        heading.isListTitle
+      ) {
+        isListTitleParent = true
+        listTitleParentFound = true
+      }
+
+      const isParent = parentCandidate.level < levelCurrent
+
+      if (isParent || isListTitleParent) {
+        levelCurrent = parentCandidate.level
+        parentHeadings.push(parentCandidate)
+      }
+    })
+  return parentHeadings
+}
+
+function assertHeadingsUrl(headings: { url?: string }[]) {
+  const urls: Record<string, true> = {}
+  headings.forEach((heading) => {
+    if (heading.url) {
+      const { url } = heading
+      assert(url.startsWith('/'))
+      assert(!urls[url], { url })
+      urls[url] = true
+    }
+  })
+}
+
+function getListPrefix() {
+  const nonBreakingSpace = String.fromCodePoint(0x00a0)
+  const bulletPoint = String.fromCodePoint(0x2022)
+  return nonBreakingSpace + bulletPoint + nonBreakingSpace
+}
+
+function parseTitle(title: string): JSX.Element {
+  type Part = { nodeType: 'text' | 'code'; content: string }
+  const parts: Part[] = []
+  let current: Part | undefined
+  title.split('').forEach((letter) => {
+    if (letter === '`') {
+      if (current?.nodeType === 'code') {
+        // </code>
+        parts.push(current)
+        current = undefined
+      } else {
+        // <code>
+        if (current) {
+          parts.push(current)
+        }
+        current = { nodeType: 'code', content: '' }
+      }
+    } else {
+      if (!current) {
+        current = { nodeType: 'text', content: '' }
+      }
+      current.content += letter
+    }
+  })
+  if (current) {
+    parts.push(current)
+  }
+
+  const titleJsx = React.createElement(
+    React.Fragment,
+    {},
+    ...parts.map((part) => {
+      if (part.nodeType === 'code') {
+        return React.createElement('code', {}, part.content)
+      } else {
+        assert(part.nodeType === 'text')
+        return part.content
+      }
+    })
+  )
+
+  return titleJsx
+}
+
+function withEmoji(name: EmojiName, title: string | JSX.Element): JSX.Element {
+  const style = { fontSize: '1.4em' }
+  //return React.createElement(React.Fragment, null, Emoji({ name, style }), ' ', title)
+  return React.createElement(
+    'span',
+    { style },
+    Emoji({ name }),
+    ' ',
+    React.createElement('span', { style: { fontSize: '1rem' } }, title)
+  )
+}

package/src/icons/changelog.svg

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="17.284" height="17.284" version="1.1" viewBox="0 0 17.284 17.284" xml:space="preserve" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"><defs><clipPath id="clipPath1075"><path d="m789.58 466.67h62.5v62.5h-62.5z" clip-rule="evenodd"/></clipPath></defs><g fill="#323d48" transform="matrix(.33185 0 0 .33185 -263.75 -156.59)" clip-path="url(#clipPath1075)"><g transform="matrix(2.6042,0,0,2.6042,789.58,466.67)"><path d="m12 2c5.523 0 10 4.477 10 10s-4.477 10-10 10-10-4.477-10-10h2c0 4.418 3.582 8 8 8s8-3.582 8-8-3.582-8-8-8c-2.464 0-4.668 1.114-6.135 2.865l2.135 2.135h-6v-6l2.447 2.446c1.833-2.11 4.537-3.446 7.553-3.446zm1 5v4.585l3.243 3.243-1.415 1.415-3.828-3.83v-5.413z"/></g></g></svg>

package/src/icons/discord.svg

@@ -0,0 +1,10 @@
+<svg width="71" height="55" viewBox="0 0 71 55" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0)">
+<path d="M60.1045 4.8978C55.5792 2.8214 50.7265 1.2916 45.6527 0.41542C45.5603 0.39851 45.468 0.440769 45.4204 0.525289C44.7963 1.6353 44.105 3.0834 43.6209 4.2216C38.1637 3.4046 32.7345 3.4046 27.3892 4.2216C26.905 3.0581 26.1886 1.6353 25.5617 0.525289C25.5141 0.443589 25.4218 0.40133 25.3294 0.41542C20.2584 1.2888 15.4057 2.8186 10.8776 4.8978C10.8384 4.9147 10.8048 4.9429 10.7825 4.9795C1.57795 18.7309 -0.943561 32.1443 0.293408 45.3914C0.299005 45.4562 0.335386 45.5182 0.385761 45.5576C6.45866 50.0174 12.3413 52.7249 18.1147 54.5195C18.2071 54.5477 18.305 54.5139 18.3638 54.4378C19.7295 52.5728 20.9469 50.6063 21.9907 48.5383C22.0523 48.4172 21.9935 48.2735 21.8676 48.2256C19.9366 47.4931 18.0979 46.6 16.3292 45.5858C16.1893 45.5041 16.1781 45.304 16.3068 45.2082C16.679 44.9293 17.0513 44.6391 17.4067 44.3461C17.471 44.2926 17.5606 44.2813 17.6362 44.3151C29.2558 49.6202 41.8354 49.6202 53.3179 44.3151C53.3935 44.2785 53.4831 44.2898 53.5502 44.3433C53.9057 44.6363 54.2779 44.9293 54.6529 45.2082C54.7816 45.304 54.7732 45.5041 54.6333 45.5858C52.8646 46.6197 51.0259 47.4931 49.0921 48.2228C48.9662 48.2707 48.9102 48.4172 48.9718 48.5383C50.038 50.6034 51.2554 52.5699 52.5959 54.435C52.6519 54.5139 52.7526 54.5477 52.845 54.5195C58.6464 52.7249 64.529 50.0174 70.6019 45.5576C70.6551 45.5182 70.6887 45.459 70.6943 45.3942C72.1747 30.0791 68.2147 16.7757 60.1968 4.9823C60.1772 4.9429 60.1437 4.9147 60.1045 4.8978ZM23.7259 37.3253C20.2276 37.3253 17.3451 34.1136 17.3451 30.1693C17.3451 26.225 20.1717 23.0133 23.7259 23.0133C27.308 23.0133 30.1626 26.2532 30.1066 30.1693C30.1066 34.1136 27.28 37.3253 23.7259 37.3253ZM47.3178 37.3253C43.8196 37.3253 40.9371 34.1136 40.9371 30.1693C40.9371 26.225 43.7636 23.0133 47.3178 23.0133C50.9 23.0133 53.7545 26.2532 53.6986 30.1693C53.6986 34.1136 50.9 37.3253 47.3178 37.3253Z" fill="#5865F2"/>
+</g>
+<defs>
+<clipPath id="clip0">
+<rect width="71" height="55" fill="white"/>
+</clipPath>
+</defs>
+</svg>