Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Meta] [New docs] Convert components docs text content to MDX #7404

Open
tkajtoch opened this issue Dec 7, 2023 · 0 comments
Open

[Meta] [New docs] Convert components docs text content to MDX #7404

tkajtoch opened this issue Dec 7, 2023 · 0 comments
Labels
meta New EUI site task A task associated with a larger Meta issue

Comments

@tkajtoch
Copy link
Member

tkajtoch commented Dec 7, 2023 •
edited
Loading

Summary

We need to convert component docs content to MDX to be able to load it in docusaurus easily.
This meta issue covers components text documentation only, excluding component previews and examples, prop tables, and playgrounds. These code-related elements must be converted to storybook stories first (#6674), then embedded into the MDX files created as deliverables of this meta issue.

Acceptance Criteria

  • All existing component documentation pages available on the current docs site should be converted to MDX and saved to /website/docs/components/<SNAKE CASE COMPONENT NAME>/overview.mdx
  • All text content should be converted to MDX, including but not limited to:
    • headings
    • paragraphs and text formatting (e.g., emphasis)
    • links
    • callouts
    • inline code
  • MDX files should be formatted using built-in Markdown features only. Please don't use EUI components, HTML tags, or CSS to achieve custom text formatting
  • All MDX component docs should have frontmatter defined on top of the file following the format: 
    ---
title: '<HUMAN-READABLE COMPONENT NAME, e.g., Combo box>'
slug: '<SLUGIFIED, HUMAN-READABLE COMPONENT NAME, e.g., combo-box>'
export_name: '<COMPONENT EXPORT NAME, e.g., EuiComboBox>'
---
  • All MDX component docs directories should have the _category_.yml file created and including these properties: 
    link:
  type: doc
  id: components/<SNAKE CASE COMPONENT NAME>/overview

Example directory structure

/website/docs/
  components/
    combo_box/
      _category_.yml
      overview.mdx

Content conversion script 👈🏻

You may use a script like this to automatically convert EUI page contents to Markdown.

Converted components
Preview Give feedback
This was referenced Dec 7, 2023
Open
Merged
This was referenced Dec 22, 2023
Merged
Merged
@JasonStoltz JasonStoltz added the task A task associated with a larger Meta issue label Apr 8, 2024
@github-actions github-actions bot added the Stale label Oct 4, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 11, 2024
@cee-chen cee-chen removed the Stale label Oct 14, 2024
@cee-chen cee-chen reopened this Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
meta New EUI site task A task associated with a larger Meta issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@cee-chen @tkajtoch @JasonStoltz