diff --git a/CHANGELOG.md b/CHANGELOG.md index e9275b9..debf466 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,19 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.0.0-alpha.34](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.33...v1.0.0-alpha.34) (2023-06-09) + +### Bug Fixes + +- set text-decoration of TOCCollapsible links to none ([7922783](https://github.com/acid-info/logos-docusaurus-plugins/commit/792278395192e3dcef7c9157a313e2b48025b02b)) + +# [1.0.0-alpha.33](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.32...v1.0.0-alpha.33) (2023-06-09) + +### Bug Fixes + +- render mobile toc after page title ([88cc89f](https://github.com/acid-info/logos-docusaurus-plugins/commit/88cc89fceea0cd4401750fe49238c40108248da6)) +- update search result icons ([bee5df3](https://github.com/acid-info/logos-docusaurus-plugins/commit/bee5df33fbb664d48f3d65dfa14e56694031041a)) + # [1.0.0-alpha.32](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.31...v1.0.0-alpha.32) (2023-06-07) ### Bug Fixes diff --git a/lerna.json b/lerna.json index dfca491..470bd0b 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "1.0.0-alpha.32", + "version": "1.0.0-alpha.34", "npmClient": "yarn", "useWorkspaces": true, "$schema": "node_modules/lerna/schemas/lerna-schema.json" diff --git a/packages/logos-docusaurus-preset/CHANGELOG.md b/packages/logos-docusaurus-preset/CHANGELOG.md index 395f106..e3a3410 100644 --- a/packages/logos-docusaurus-preset/CHANGELOG.md +++ b/packages/logos-docusaurus-preset/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.0.0-alpha.34](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.33...v1.0.0-alpha.34) (2023-06-09) + +**Note:** Version bump only for package @acid-info/logos-docusaurus-preset + +# [1.0.0-alpha.33](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.32...v1.0.0-alpha.33) (2023-06-09) + +**Note:** Version bump only for package @acid-info/logos-docusaurus-preset + # [1.0.0-alpha.32](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.31...v1.0.0-alpha.32) (2023-06-07) **Note:** Version bump only for package @acid-info/logos-docusaurus-preset diff --git a/packages/logos-docusaurus-preset/package.json b/packages/logos-docusaurus-preset/package.json index aa3e1eb..617c7e6 100644 --- a/packages/logos-docusaurus-preset/package.json +++ b/packages/logos-docusaurus-preset/package.json @@ -1,6 +1,6 @@ { "name": "@acid-info/logos-docusaurus-preset", - "version": "1.0.0-alpha.32", + "version": "1.0.0-alpha.34", "description": "Docusaurus preset for Logos documentation websites", "main": "lib/index.js", "types": "src/preset.d.ts", @@ -17,7 +17,7 @@ }, "dependencies": { "@acid-info/logos-docusaurus-search-local": "^1.0.0-alpha.19", - "@acid-info/logos-docusaurus-theme": "^1.0.0-alpha.32", + "@acid-info/logos-docusaurus-theme": "^1.0.0-alpha.34", "@docusaurus/core": "^2.4.1", "@docusaurus/module-type-aliases": "^2.4.1", "@docusaurus/preset-classic": "^2.4.1", diff --git a/packages/logos-docusaurus-theme/CHANGELOG.md b/packages/logos-docusaurus-theme/CHANGELOG.md index 65bb376..55b575b 100644 --- a/packages/logos-docusaurus-theme/CHANGELOG.md +++ b/packages/logos-docusaurus-theme/CHANGELOG.md @@ -3,6 +3,19 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.0.0-alpha.34](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.33...v1.0.0-alpha.34) (2023-06-09) + +### Bug Fixes + +- set text-decoration of TOCCollapsible links to none ([7922783](https://github.com/acid-info/logos-docusaurus-plugins/commit/792278395192e3dcef7c9157a313e2b48025b02b)) + +# [1.0.0-alpha.33](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.32...v1.0.0-alpha.33) (2023-06-09) + +### Bug Fixes + +- render mobile toc after page title ([88cc89f](https://github.com/acid-info/logos-docusaurus-plugins/commit/88cc89fceea0cd4401750fe49238c40108248da6)) +- update search result icons ([bee5df3](https://github.com/acid-info/logos-docusaurus-plugins/commit/bee5df33fbb664d48f3d65dfa14e56694031041a)) + # [1.0.0-alpha.32](https://github.com/acid-info/logos-docusaurus-plugins/compare/v1.0.0-alpha.31...v1.0.0-alpha.32) (2023-06-07) ### Bug Fixes diff --git a/packages/logos-docusaurus-theme/package.json b/packages/logos-docusaurus-theme/package.json index 6f4409a..d4eef95 100644 --- a/packages/logos-docusaurus-theme/package.json +++ b/packages/logos-docusaurus-theme/package.json @@ -1,6 +1,6 @@ { "name": "@acid-info/logos-docusaurus-theme", - "version": "1.0.0-alpha.32", + "version": "1.0.0-alpha.34", "description": "A Docusaurus theme for Logos documentation websites", "main": "lib/index.js", "types": "src/theme.d.ts", diff --git a/packages/logos-docusaurus-theme/src/client/containers/MDXEnhacement/MDXEnhancement.context.ts b/packages/logos-docusaurus-theme/src/client/containers/MDXEnhacement/MDXEnhancement.context.ts new file mode 100644 index 0000000..f95ef35 --- /dev/null +++ b/packages/logos-docusaurus-theme/src/client/containers/MDXEnhacement/MDXEnhancement.context.ts @@ -0,0 +1,36 @@ +import React, { useContext, useMemo } from 'react' + +export type MDXComponentType = 'heading' +export type MDXEnhancementPosition = 'after' + +export type MDXEnhancementItem = { + component: MDXComponentType + position: MDXEnhancementPosition + render: (props: any) => React.ReactNode +} + +export type MDXEnhancementContextType = { + items: MDXEnhancementItem[] +} + +export const MDXEnhancementContext = + React.createContext({ + items: [], + }) + +export const useMDXEnhancementElements = ( + component: MDXComponentType, + position: MDXEnhancementPosition, + props: T, +): React.ReactNode => { + const ctx = useContext(MDXEnhancementContext) + if (!ctx) return [] + + return useMemo(() => { + const items = ctx.items.filter( + (item) => item.component === component && item.position === position, + ) + + return items.map((item) => item.render(props)) + }, [component, position, props]) +} diff --git a/packages/logos-docusaurus-theme/src/client/containers/MDXEnhacement/index.ts b/packages/logos-docusaurus-theme/src/client/containers/MDXEnhacement/index.ts new file mode 100644 index 0000000..16422cd --- /dev/null +++ b/packages/logos-docusaurus-theme/src/client/containers/MDXEnhacement/index.ts @@ -0,0 +1 @@ +export * from './MDXEnhancement.context' diff --git a/packages/logos-docusaurus-theme/src/client/css/custom.scss b/packages/logos-docusaurus-theme/src/client/css/custom.scss index 2b6044a..646deaa 100644 --- a/packages/logos-docusaurus-theme/src/client/css/custom.scss +++ b/packages/logos-docusaurus-theme/src/client/css/custom.scss @@ -231,6 +231,9 @@ --desktop-footer-gap: 200px; --mobile-footer-gap: 144px; --doc-grid-gap: 16px; + + --ifm-table-background: transparent !important; + --ifm-table-stripe-background: transparent !important; @include utils.responsive('xl', 'down') { --container-max-width: 912px; @@ -477,6 +480,19 @@ small { @include lsd.typography('body2'); } +.menu__link--sublist-caret:after { + content: url(/icons/chevron-up.svg); + background: none; + filter: unset; + min-width: unset; + width: unset; + height: unset; +} + +.menu__list-item--collapsed > .menu__link--sublist-caret:after { + transform: rotateZ(0deg) !important; +} + .menu__link--active { border-left: 1px solid rgb(var(--lsd-border-primary)); border-radius: 0; @@ -624,6 +640,48 @@ a[class^='sidebarLogo_'] { } } +table { + @include lsd.typography('body2'); + thead > tr { + border: 1px solid rgb(var(--lsd-border-primary)); + } + + th { + text-transform: uppercase; + font-weight: 400 !important; + border: 1px solid rgb(var(--lsd-border-primary)); + text-align: left; + } + + td { + border: 1px solid rgb(var(--lsd-border-primary)); + strong { + text-transform: uppercase; + font-weight: 400 !important; + } + } +} + +.theme-doc-footer { + margin-bottom: 96px; +} + +.theme-doc-footer-edit-meta-row { + div[class*='lastUpdated_'] { + @include lsd.typography('body2'); + font-style: normal; + opacity: 0.7; + + small { + display: none; + } + + b { + font-weight: 400 !important; + } + } +} + .navbar-sidebar__item { padding-inline: var(--content-padding); padding-block: 0; @@ -1000,26 +1058,10 @@ a[class^='sidebarLogo_'] { } .navbar-sidebar:not(.navbar-sidebar--show-secondary) { - .navbar-sidebar__brand { - button:first-of-type { - display: none; - } - - button.lsd-icon-button { - margin-left: auto; - } - } - .menu { padding-inline: 0; } - .navbar-sidebar__items { - } - - .navbar-sidebar__item { - } - .menu__list { display: flex; flex-direction: column; @@ -1054,12 +1096,17 @@ a[class^='sidebarLogo_'] { .footer .container.container-fluid { margin-bottom: 16px !important; + padding-inline: var(--content-padding); > .footer__links { gap: 0 !important; } } + .footer > div[class*='secondRow'] { + margin: var(--content-padding); + } + .footer .footer__links { gap: 16px !important; } diff --git a/packages/logos-docusaurus-theme/src/client/static/icons/chevron-up.svg b/packages/logos-docusaurus-theme/src/client/static/icons/chevron-up.svg new file mode 100644 index 0000000..9c20b96 --- /dev/null +++ b/packages/logos-docusaurus-theme/src/client/static/icons/chevron-up.svg @@ -0,0 +1,3 @@ + + + diff --git a/packages/logos-docusaurus-theme/src/client/static/icons/hashtag.svg b/packages/logos-docusaurus-theme/src/client/static/icons/hashtag.svg index 4a771d5..e16e3b3 100644 --- a/packages/logos-docusaurus-theme/src/client/static/icons/hashtag.svg +++ b/packages/logos-docusaurus-theme/src/client/static/icons/hashtag.svg @@ -1,3 +1,3 @@ - - - + + + \ No newline at end of file diff --git a/packages/logos-docusaurus-theme/src/client/theme/DocItem/Content/index.tsx b/packages/logos-docusaurus-theme/src/client/theme/DocItem/Content/index.tsx index 9885168..03088b7 100644 --- a/packages/logos-docusaurus-theme/src/client/theme/DocItem/Content/index.tsx +++ b/packages/logos-docusaurus-theme/src/client/theme/DocItem/Content/index.tsx @@ -4,6 +4,7 @@ import { ThemeClassNames } from '@docusaurus/theme-common' import { useDoc } from '@docusaurus/theme-common/internal' import Heading from '@theme/Heading' import MDXContent from '@theme/MDXContent' +import MDXHeading from '@theme/MDXComponents/Heading' /** Title can be declared inside md content or declared through front matter and added manually. To make both cases consistent, @@ -29,7 +30,7 @@ export default function DocItemContent({ children }) {
{syntheticTitle && (
- {syntheticTitle} + {syntheticTitle}
)} {children} diff --git a/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/index.tsx b/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/index.tsx index e0bf6de..52977dc 100644 --- a/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/index.tsx +++ b/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/index.tsx @@ -1,17 +1,19 @@ -import React from 'react' -import clsx from 'clsx' import { useWindowSize } from '@docusaurus/theme-common' import { useDoc } from '@docusaurus/theme-common/internal' -import DocItemPaginator from '@theme/DocItem/Paginator' -import DocVersionBanner from '@theme/DocVersionBanner' -import DocVersionBadge from '@theme/DocVersionBadge' -import DocItemFooter from '@theme/DocItem/Footer' -import DocItemTOCMobile from '@theme/DocItem/TOC/Mobile' -import DocItemTOCDesktop from '@theme/DocItem/TOC/Desktop' -import DocItemContent from '@theme/DocItem/Content' import DocBreadcrumbs from '@theme/DocBreadcrumbs' -import styles from './styles.module.scss' +import DocItemContent from '@theme/DocItem/Content' +import DocItemFooter from '@theme/DocItem/Footer' +import DocItemPaginator from '@theme/DocItem/Paginator' +import DocItemTOCDesktop from '@theme/DocItem/TOC/Desktop' +import DocItemTOCMobile from '@theme/DocItem/TOC/Mobile' +import DocVersionBadge from '@theme/DocVersionBadge' +import DocVersionBanner from '@theme/DocVersionBanner' +import { Props as HeadingProps } from '@theme/Heading' +import clsx from 'clsx' +import React from 'react' import { useMedia } from 'react-use' +import { MDXEnhancementContext } from '../../../containers/MDXEnhacement/MDXEnhancement.context' +import styles from './styles.module.scss' /** * Decide if the toc should be rendered, on mobile or desktop viewports @@ -44,14 +46,26 @@ export default function DocItemLayout({ children }) { return (
-
+
- {docTOC.mobile} - {children} + + props.as === 'h1' && docTOC.mobile, + }, + ], + }} + > + {children} +
diff --git a/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/styles.module.scss b/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/styles.module.scss index 9e5c12a..5b366f5 100644 --- a/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/styles.module.scss +++ b/packages/logos-docusaurus-theme/src/client/theme/DocItem/Layout/styles.module.scss @@ -20,8 +20,18 @@ } .tocMobile { + margin-top: -0.5rem; + margin-bottom: 2rem; + & > div { display: block !important; + margin: 0; + } +} + +.docItemContainer { + .tocMobile:not(:first-of-type) { + display: none; } } diff --git a/packages/logos-docusaurus-theme/src/client/theme/MDXComponents/Heading.tsx b/packages/logos-docusaurus-theme/src/client/theme/MDXComponents/Heading.tsx new file mode 100644 index 0000000..b8854c3 --- /dev/null +++ b/packages/logos-docusaurus-theme/src/client/theme/MDXComponents/Heading.tsx @@ -0,0 +1,15 @@ +import Heading from '@docusaurus/theme-classic/lib/theme/MDXComponents/Heading' +import type { Props } from '@theme/MDXComponents/Heading' +import React from 'react' +import { useMDXEnhancementElements } from '../../containers/MDXEnhacement/MDXEnhancement.context' + +export default function MDXHeading(props: Props): JSX.Element { + const after = useMDXEnhancementElements('heading', 'after', props) + + return ( + <> + + {after} + + ) +} diff --git a/packages/logos-docusaurus-theme/src/client/theme/SearchBar/SearchResultItem/SearchResultItem.tsx b/packages/logos-docusaurus-theme/src/client/theme/SearchBar/SearchResultItem/SearchResultItem.tsx index fe3393f..662b659 100644 --- a/packages/logos-docusaurus-theme/src/client/theme/SearchBar/SearchResultItem/SearchResultItem.tsx +++ b/packages/logos-docusaurus-theme/src/client/theme/SearchBar/SearchResultItem/SearchResultItem.tsx @@ -9,7 +9,7 @@ import styles from './SearchResultItem.module.scss' const icons: Record = { [SearchDocumentType.Title]: ( - + ), [SearchDocumentType.Heading]: ( diff --git a/packages/logos-docusaurus-theme/src/client/theme/TOCCollapsible/styles.module.css b/packages/logos-docusaurus-theme/src/client/theme/TOCCollapsible/styles.module.css index fd81641..a9f7d54 100644 --- a/packages/logos-docusaurus-theme/src/client/theme/TOCCollapsible/styles.module.css +++ b/packages/logos-docusaurus-theme/src/client/theme/TOCCollapsible/styles.module.css @@ -18,6 +18,7 @@ .tocCollapsibleContent a { display: block; + text-decoration: var(--ifm-link-text-decoration); } .tocCollapsibleExpanded {