packages/docs-site/lib/pages

Page templates: pure functions from data to HTML strings.

Docs site, next. Source: packages/docs-site/lib/pages.mjs.

Functions#

docBody()#

docBody(__namedParameters): string

Defined in: packages/docs-site/lib/pages.mjs:112

A docs page: title heading + lede + rendered markdown.

Parameters#

__namedParameters

html

any

lede

any

title

any

Returns#

string

---

homeBody()#

homeBody(): string

Defined in: packages/docs-site/lib/pages.mjs:116

Returns#

string

---

layout()#

layout(page, __namedParameters): string

Defined in: packages/docs-site/lib/pages.mjs:20

Wrap a page body in the shared chrome. page: { path, title, description, section: 'home'|'user'|'dev'|'none', body, nav?, headings?, sourceUrl?, canonical?, ogImage?, crumbs? } nav: [{ group, items: [{ title, path }] }] for the sidebar

Parameters#

page

any

__namedParameters

basePath

any

buildTime

any

repoUrl

any

version

any

versions

any

Returns#

string

---

notFoundBody()#

notFoundBody(__namedParameters): string

Defined in: packages/docs-site/lib/pages.mjs:178

Parameters#

__namedParameters

basePath

any

Returns#

string

---

redirectPage()#

redirectPage(__namedParameters): string

Defined in: packages/docs-site/lib/pages.mjs:173

Parameters#

__namedParameters

title

any

to

any

Returns#

string

---

rootFor()#

rootFor(pagePath): string

Defined in: packages/docs-site/lib/pages.mjs:9

Parameters#

pagePath

any

Returns#

string

---

searchBody()#

searchBody(__namedParameters): string

Defined in: packages/docs-site/lib/pages.mjs:155

Parameters#

__namedParameters

root

any

Returns#

string

---

sectionBody()#

sectionBody(__namedParameters): string

Defined in: packages/docs-site/lib/pages.mjs:144

A section landing page: intro + a card list of its pages.

Parameters#

__namedParameters

groups

any

html

any

lede

any

root

any

title

any

Returns#

string