@brillout/docpress 0.13.2 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/+config.ts +11 -16
  2. package/EditLink.tsx +1 -1
  3. package/ExternalLinks.tsx +2 -2
  4. package/Layout.tsx +24 -21
  5. package/MenuModal.tsx +1 -1
  6. package/NavItemComponent.tsx +1 -1
  7. package/components/Link.tsx +4 -4
  8. package/components/RepoLink.tsx +1 -1
  9. package/{renderer/determineNavItemsColumnLayout.ts → determineNavItemsColumnLayout.ts} +2 -3
  10. package/dist/+config.d.ts +9 -20
  11. package/dist/+config.js +3 -11
  12. package/dist/NavItemComponent.js +1 -1
  13. package/dist/components/Link.js +1 -1
  14. package/dist/components/RepoLink.js +1 -1
  15. package/dist/{renderer/determineNavItemsColumnLayout.d.ts → determineNavItemsColumnLayout.d.ts} +1 -1
  16. package/dist/{renderer/determineNavItemsColumnLayout.js → determineNavItemsColumnLayout.js} +1 -2
  17. package/dist/parsePageSections.js +1 -1
  18. package/dist/renderer/usePageContext.d.ts +17 -10
  19. package/dist/renderer/usePageContext.js +11 -19
  20. package/dist/resolveConf.d.ts +19 -0
  21. package/dist/{config/resolveHeadingsData.js → resolveConf.js} +24 -29
  22. package/dist/types/Config.d.ts +1 -0
  23. package/dist/types/Heading.d.ts +9 -14
  24. package/docsearch/DocSearchInstall.tsx +1 -1
  25. package/index.ts +5 -1
  26. package/installSectionUrlHashs.ts +1 -0
  27. package/package.json +7 -9
  28. package/parsePageSections.ts +1 -1
  29. package/renderer/getPageElement.tsx +7 -15
  30. package/renderer/onCreatePageContext.ts +8 -0
  31. package/renderer/onRenderClient.tsx +2 -8
  32. package/renderer/onRenderHtml.tsx +53 -23
  33. package/renderer/usePageContext.tsx +12 -28
  34. package/{config/resolveHeadingsData.ts → resolveConf.ts} +30 -52
  35. package/tsconfig.config.json +1 -4
  36. package/tsconfig.json +1 -0
  37. package/types/Config.ts +1 -0
  38. package/types/Heading.ts +13 -20
  39. package/config/resolveConfig/resolveHeading.ts +0 -0
  40. package/config/resolvePageContext.ts +0 -49
  41. package/dist/config/resolveHeadingsData.d.ts +0 -24
  42. package/dist/config/resolvePageContext.d.ts +0 -41
  43. package/dist/config/resolvePageContext.js +0 -25
  44. package/renderer/onBeforeRender.ts +0 -12
package/config/resolvePageContext.ts DELETED
@@ -1,49 +0,0 @@
1
- export { resolvePageContext }
2
- export type { PageContextOriginal }
3
- export type { PageContextResolved }
4
- export type { Exports }
5
-
6
- import { objectAssign } from '../utils/server'
7
- import type { PageContextServer } from 'vike/types'
8
- import type { PageSection } from '../parsePageSections'
9
- import { resolveHeadingsData } from './resolveHeadingsData'
10
-
11
- type Exports = {
12
- pageSectionsExport?: PageSection[]
13
- }
14
- // TODO/refactor: remove PageContextOriginal in favor of using PageContextServer
15
- type PageContextOriginal = PageContextServer
16
-
17
- type PageContextResolved = ReturnType<typeof resolvePageContext>
18
-
19
- function resolvePageContext(pageContext: PageContextOriginal) {
20
- const pageContextResolved = {}
21
-
22
- objectAssign(pageContextResolved, resolveHeadingsData(pageContext))
23
-
24
- const config = pageContext.config.docpress!
25
- const {
26
- algolia,
27
- tagline,
28
- twitterHandle,
29
- bannerUrl,
30
- websiteUrl,
31
- projectInfo: { projectName },
32
- } = config
33
- const logoUrl = config.logoUrl ?? config.faviconUrl
34
- objectAssign(pageContextResolved, {
35
- urlPathname: pageContext.urlPathname, // TODO: remove
36
- meta: {
37
- projectName,
38
- logoUrl,
39
- twitterHandle,
40
- bannerUrl,
41
- websiteUrl,
42
- tagline,
43
- algolia,
44
- },
45
- config,
46
- })
47
-
48
- return pageContextResolved
49
- }
package/dist/config/resolveHeadingsData.d.ts DELETED
@@ -1,24 +0,0 @@
1
- export { resolveHeadingsData };
2
- export type { ActiveCategory };
3
- import type { NavItem } from '../NavItemComponent';
4
- import type { LinkData } from '../components';
5
- import type { PageContextOriginal } from './resolvePageContext';
6
- type ActiveCategory = {
7
- name: string;
8
- order: number;
9
- hide?: boolean;
10
- };
11
- declare function resolveHeadingsData(pageContext: PageContextOriginal): {
12
- navItemsAll: NavItem[];
13
- navItemsDetached: NavItem[] | undefined;
14
- pageDesign: {
15
- hideTitle?: true;
16
- hideMenuLeft?: true;
17
- contentMaxWidth?: number;
18
- } | undefined;
19
- linksAll: LinkData[];
20
- isLandingPage: boolean;
21
- pageTitle: string | null;
22
- documentTitle: string;
23
- activeCategory: ActiveCategory;
24
- };
package/dist/config/resolvePageContext.d.ts DELETED
@@ -1,41 +0,0 @@
1
- export { resolvePageContext };
2
- export type { PageContextOriginal };
3
- export type { PageContextResolved };
4
- export type { Exports };
5
- import type { PageContextServer } from 'vike/types';
6
- import type { PageSection } from '../parsePageSections';
7
- type Exports = {
8
- pageSectionsExport?: PageSection[];
9
- };
10
- type PageContextOriginal = PageContextServer;
11
- type PageContextResolved = ReturnType<typeof resolvePageContext>;
12
- declare function resolvePageContext(pageContext: PageContextOriginal): {
13
- navItemsAll: import("../NavItemComponent").NavItem[];
14
- navItemsDetached: import("../NavItemComponent").NavItem[] | undefined;
15
- pageDesign: {
16
- hideTitle?: true;
17
- hideMenuLeft?: true;
18
- contentMaxWidth?: number;
19
- } | undefined;
20
- linksAll: import("../components").LinkData[];
21
- isLandingPage: boolean;
22
- pageTitle: string | null;
23
- documentTitle: string;
24
- activeCategory: import("./resolveHeadingsData").ActiveCategory;
25
- } & {
26
- urlPathname: string;
27
- meta: {
28
- projectName: string;
29
- logoUrl: string | undefined;
30
- twitterHandle: string;
31
- bannerUrl: string | undefined;
32
- websiteUrl: string;
33
- tagline: string;
34
- algolia: {
35
- appId: string;
36
- apiKey: string;
37
- indexName: string;
38
- } | null;
39
- };
40
- config: import("../types/Config").Config;
41
- };
package/dist/config/resolvePageContext.js DELETED
@@ -1,25 +0,0 @@
1
- export { resolvePageContext };
2
- import { objectAssign } from '../utils/server';
3
- import { resolveHeadingsData } from './resolveHeadingsData';
4
- function resolvePageContext(pageContext) {
5
- var _a;
6
- var pageContextResolved = {};
7
- objectAssign(pageContextResolved, resolveHeadingsData(pageContext));
8
- var config = pageContext.config.docpress;
9
- var algolia = config.algolia, tagline = config.tagline, twitterHandle = config.twitterHandle, bannerUrl = config.bannerUrl, websiteUrl = config.websiteUrl, projectName = config.projectInfo.projectName;
10
- var logoUrl = (_a = config.logoUrl) !== null && _a !== void 0 ? _a : config.faviconUrl;
11
- objectAssign(pageContextResolved, {
12
- urlPathname: pageContext.urlPathname, // TODO: remove
13
- meta: {
14
- projectName: projectName,
15
- logoUrl: logoUrl,
16
- twitterHandle: twitterHandle,
17
- bannerUrl: bannerUrl,
18
- websiteUrl: websiteUrl,
19
- tagline: tagline,
20
- algolia: algolia,
21
- },
22
- config: config,
23
- });
24
- return pageContextResolved;
25
- }
package/renderer/onBeforeRender.ts DELETED
@@ -1,12 +0,0 @@
1
- export { onBeforeRender }
2
-
3
- import { resolvePageContext, type PageContextOriginal } from '../config/resolvePageContext'
4
-
5
- function onBeforeRender(pageContextOriginal: PageContextOriginal) {
6
- const pageContextResolved = resolvePageContext(pageContextOriginal)
7
- return {
8
- pageContext: {
9
- pageContextResolved,
10
- },
11
- }
12
- }