feat: non-react playgrounds for docs #171
Open
Conversation
This file contains 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
orteth01
commented
Jan 16, 2025
|
|
||
| /** @type {Partial<import("typedoc").TypeDocOptions>} */ | ||
| export default { | ||
| name: '@accelint/constants', |
There was a problem hiding this comment.
i think there may be a bug in typedoc related to using the 'packages' entry point strategy. for whatever reason, context.project.name in the createSignature event was an empty string, unless we explicitly set the name like this in each package. in theory, it should just be getting this from package.json....
There was a problem hiding this comment.
Interesting. Not too surprising.
orteth01
commented
Jan 16, 2025
orteth01
commented
Jan 16, 2025
| template='vanilla-ts' | ||
| customSetup={{ | ||
| dependencies: Object.fromEntries( | ||
| dependencies.map((dep) => [dep, 'latest']), |
There was a problem hiding this comment.
i just pinned to latest... i'm open to a more complex/flexible structure for the dependencies prop, if that's preferable
orteth01
commented
Jan 16, 2025
Comment on lines
22
to
41
| function convertPlaygroundBlockToComponent(context, reflection) { | ||
| const playgroundTag = reflection?.comment?.blockTags?.find( | ||
| ({ tag }) => tag === '@playground', | ||
| ); | ||
|
|
||
| if (playgroundTag) { | ||
| const code = playgroundTag.content[0].text.trim(); | ||
| playgroundTag.content = [ | ||
| { | ||
| kind: 'text', | ||
| text: `import { Playground } from '@site/src/components/playground'; | ||
|
|
||
| <Playground | ||
| code={\`${code}\`} | ||
| dependencies={['${context.project.name}']} | ||
| /> | ||
| `, | ||
| }, | ||
| ]; | ||
| } |
There was a problem hiding this comment.
ended up being fairly simple
- look for the
@playgroundtag - if it's there, replace the content w/ our playground component, passing the original content of the block as the
codeprop
orteth01
requested review from
kalisjoshua,
brandonjpierce,
ArrayKnight,
switzerb and
belsrc
as code owners
orteth01
commented
Jan 16, 2025
Comment on lines
+19
to
26
| * @playground | ||
| * import { booleanToNumber } from '@accelint/converters'; | ||
| * | ||
| * console.log(booleanToNumber(true)); | ||
| * // 1 | ||
| * | ||
| * booleanToNumber(false); | ||
| * console.log(booleanToNumber(false)); | ||
| * // 0 |
There was a problem hiding this comment.
example @playground block
orteth01
commented
Jan 16, 2025
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.
✅ Pull Request Checklist:
📝 Test Instructions:
@playgroundblock JSDoc comment in package codesee
packages/converters/src/boolean-to-number/index.tsfor an example of a@playgroundcomment❓ Does this PR introduce a breaking change?
💬 Other information
@playgroundcomment and how it works.