fix(microsite): core-components docs layout fixed

Signed-off-by: Viachaslau Auchynnikau <viachaslau_auchynnikau@epam.com>
2022-10-15 16:40:56 +03:00
parent ecd3b23ac9
commit 98932961ea
14 changed files with 20 additions and 8 deletions
@@ -44,6 +44,7 @@ export interface LogViewerProps {
 /**
 * A component that displays logs in a scrollable text area.
 *
+ * @remarks
 * The LogViewer has support for search and filtering, as well as displaying
 * text content with ANSI color escape codes.
 *
@@ -110,10 +110,10 @@ const components: Options['components'] = {
 };

 /**
- * MarkdownContent
- * --
- * Renders markdown with the default dialect [gfm - GitHub flavored Markdown](https://github.github.com/gfm/) to backstage theme styled HTML.
- * If you just want to render to plain [CommonMark](https://commonmark.org/), set the dialect to `'common-mark'`
+ * Renders markdown with the default dialect {@link https://github.github.com/gfm/ | gfm - GitHub flavored Markdown} to backstage theme styled HTML.
+ *
+ * @remarks
+ * If you just want to render to plain {@link https://commonmark.org/ | CommonMark}, set the dialect to `'common-mark'`
 */
 export function MarkdownContent(props: Props) {
  const {
@@ -44,6 +44,7 @@ const useStyles = makeStyles(
 /**
 * Renders a warning panel as the effect of a failed server request.
 *
+ * @remarks
 * Has special treatment for ResponseError errors, to display rich
 * server-provided information about what happened.
 */
@@ -71,6 +71,7 @@ export function createSubRoutesFromChildren(
 * TabbedLayout is a compound component, which allows you to define a layout for
 * pages using a sub-navigation mechanism.
 *
+ * @remarks
 * Consists of two parts: TabbedLayout and TabbedLayout.Route
 *
 * @example
@@ -134,7 +134,7 @@ const capitalize = (s: string) => {
 };

 /**
- * WarningPanel. Show a user friendly error message to a user similar to
+ * Show a user friendly error message to a user similar to
 * ErrorPanel except that the warning panel only shows the warning message to
 * the user.
 *
@@ -40,6 +40,7 @@ type ItemCardProps = {
 * This card type has been deprecated. Instead use plain MUI Card and helpers
 * where appropriate.
 *
+ *  @example
 * ```
 *   <Card>
 *     <CardMedia>
@@ -49,6 +49,7 @@ export type ItemCardGridProps = Partial<WithStyles<typeof styles>> & {
 * A default grid to use when arranging "item cards" - cards that let users
 * select among several options.
 *
+ * @remarks
 * The immediate children are expected to be MUI Card components.
 *
 * Styles for the grid can be overridden using the `classes` prop, e.g.:
@@ -64,6 +64,7 @@ export type ItemCardHeaderProps = Partial<WithStyles<typeof styles>> & {
 * A simple card header, rendering a default look for "item cards" - cards that
 * are arranged in a grid for users to select among several options.
 *
+ * @remarks
 * This component expects to be placed within a MUI `<CardMedia>`.
 *
 * Styles for the header can be overridden using the `classes` prop, e.g.:
@@ -510,6 +510,7 @@ const SidebarItemWithSubmenu = ({
 /**
 * Creates a `SidebarItem`
 *
+ * @remarks
 * If children contain a `SidebarSubmenu` component the `SidebarItem` will have a expandable submenu
 */
 export const SidebarItem = forwardRef<any, SidebarItemProps>((props, ref) => {
@@ -663,6 +664,8 @@ export const SidebarScrollWrapper = styled('div')(({ theme }) => {

 /**
 * A button which allows you to expand the sidebar when clicked.
+ *
+ * @remarks
 * Use optionally to replace sidebar's expand-on-hover feature with expand-on-click.
 *
 * If you are using this you might want to set the `disableExpandOnHover` of the `Sidebar` to `true`.
@@ -159,6 +159,7 @@ export const MobileSidebarContext = createContext<MobileSidebarContextType>({
 /**
 * A navigation component for mobile screens, which sticks to the bottom.
 *
+ * @remarks
 * It alternates the normal sidebar by grouping the `SidebarItems` based on provided `SidebarGroup`s
 * either rendering them as a link or an overlay menu.
 * If no `SidebarGroup`s are provided the sidebar content is wrapped in an default overlay menu.
@@ -115,6 +115,7 @@ const MobileSidebarGroup = (props: SidebarGroupProps) => {
 /**
 * Groups items of the `Sidebar` together.
 *
+ * @remarks
 * On bigger screens, this won't have any effect at the moment.
 * On small screens, it will add an action to the bottom navigation - either triggering an overlay menu or acting as a link
 *
@@ -111,6 +111,7 @@ export type SidebarSubmenuItemDropdownItem = {
 /**
 * Holds submenu item content.
 *
+ * @remarks
 * title: Text content of submenu item
 * subtitle: A subtitle displayed under the main title
 * to: Path to navigate to when item is clicked
@@ -20,13 +20,13 @@ const drawerWidthClosed = 72;
 const iconPadding = 24;
 const userBadgePadding = 18;

-/** @public **/
+/** @public */
 export type SidebarOptions = {
  drawerWidthClosed?: number;
  drawerWidthOpen?: number;
 };

-/** @public **/
+/** @public */
 export type SubmenuOptions = {
  drawerWidthClosed?: number;
  drawerWidthOpen?: number;
@@ -32,7 +32,7 @@ export type SignInProviderConfig = {
  apiRef: ApiRef<ProfileInfoApi & BackstageIdentityApi & SessionApi>;
 };

-/** @public **/
+/** @public */
 export type IdentityProviders = ('guest' | 'custom' | SignInProviderConfig)[];

 export type ProviderComponent = ComponentType<