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.

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

Migrate components including ApiLink for the Documentation content #6120

Merged
merged 14 commits into from
Feb 26, 2025

Conversation

haneepark
Copy link
Contributor

@haneepark haneepark commented Feb 25, 2025

Motivation:

Modifications:

  • Implement remark plugin for api link.
  • Implement AspectRatio, ApiLink components.
  • Use the built-in CodeBlock component and add language support.
  • Register components to global scope to use them in every MDX file without importing.
  • Add a CLI option for not opening the browser on start.
  • Remove auto generated initial docs.

Result:

  • Api link syntax in MDX has changed from <type://RequestContext> to [RequestContext](type). See site-new/docs/api-link-test.mdx for usages. I made this change because the old syntax is no longer allowed in MDX v3. (See MDX docs)

@@ -0,0 +1,268 @@
{
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The files under /gen-src-temp are to be removed after migrating build.gradle.

Copy link
Contributor

@ikhoon ikhoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Locally tested and it worked successfully.

This reverts commit c529e09, reversing
changes made to 4fc19f8.
Copy link
Contributor

@minwoox minwoox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @haneepark!

@ikhoon ikhoon merged commit f754613 into line:site-new Feb 26, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants