Add new website component LocalSource
#1600
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request refactors the documentation code examples to use local file imports by replacing RemoteSource with a newly introduced LocalSource component. It also adds a helper function (getLocalSourceFile) to retrieve local source files and updates the .gitignore file accordingly.
Reviewed Changes
Copilot reviewed 22 out of 90 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| website/src/components/LocalSource.tsx | Introduces the LocalSource component that compiles and renders local MDX content. |
| website/src/components/internal/getLocalSourceFile.ts | Adds a helper to retrieve local files with caching and pre-build logic. |
| *.mdx files across docs repositories | Replaces RemoteSource with LocalSource for local file display in code examples. |
| examples/.gitignore | Removes the "!bin" exclusion to better support the new local file usage strategy. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
=
This pull request introduces a significant refactor of the documentation's code examples, replacing remote file references with local file imports. It also includes the addition of new helper components (
LocalSource) to support this transition. The changes improve maintainability and reduce dependency on external URLs.Refactoring to Use Local File Imports
LocalSourceComponent: Introduced theLocalSourcecomponent inwebsite/src/components/LocalSource.tsxto handle rendering of local code examples. It supports options likefilename,showLineNumbers, andhighlight. ([website/src/components/LocalSource.tsxR1-R28](https://github.com/samchon/typia/pull/1600/files#diff-6b2285a875907777f86cfdd23524aed7db06cdc56418adafe6439f3737570ca8R1-R28))getLocalSourceFileinwebsite/src/components/internal/getLocalSourceFile.tsto fetch and process local source files. This includes handling.d.tsfiles and resolving project root paths dynamically. ([website/src/components/internal/getLocalSourceFile.tsR1-R36](https://github.com/samchon/typia/pull/1600/files#diff-4bb86c2c529a6d6b36aea15bd08f9563788c3a85eca3634473d037a486dc3c08R1-R36))Updates to Documentation Files
RemoteSourcewithLocalSource: Updated multiple.mdxfiles to replaceRemoteSourcewithLocalSourcefor code examples. This change affects documentation for JSON (parse.mdx,schema.mdx,stringify.mdx) and LLM functionalities (application.mdx,chat.mdx,parameters.mdx). ([[1]](https://github.com/samchon/typia/pull/1600/files#diff-a14b2c44786d76ea5e0ecf15add526bc4722fcf1f1a1d3b947968a8b0318b38bR6),[[2]](https://github.com/samchon/typia/pull/1600/files#diff-eedd1f983565f904efb871bd9e77018f5479130bfd574392e150103f0d713f5bR6),[[3]](https://github.com/samchon/typia/pull/1600/files#diff-0d9f48646214fbe9a0062b3d8da92110e14bd62797024b98cc88d277f89cb7e2R8),[[4]](https://github.com/samchon/typia/pull/1600/files#diff-2e637ee7fad1dc9b51092ffdc31a7f619d5a87166f7cf7229f817fd927a73f0bR6),[[5]](https://github.com/samchon/typia/pull/1600/files#diff-ce26840aa7900a0aaedcf7b95dbf7ae2d74c9601147ff8281cf53cb0b454e479L6-R6),[[6]](https://github.com/samchon/typia/pull/1600/files#diff-2a36900e1c87e7693cab0b0033bd11ef3aba9a28f93ba491976e76bf4751b0cdR6))Minor Adjustments
.gitignoreUpdate: Removed!binentry from.gitignore, likely to align with the new local file usage strategy. ([examples/.gitignoreL1](https://github.com/samchon/typia/pull/1600/files#diff-6940749267f41d54935f96cc3c8e4d291602e9e70d8ac5c17d9da61e8ad305fcL1))