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

feat: Markdown renderer #139

Merged
merged 11 commits into from
Jun 21, 2023
Merged

feat: Markdown renderer #139

merged 11 commits into from
Jun 21, 2023

Conversation

PuruVJ
Copy link
Collaborator

@PuruVJ PuruVJ commented Jun 19, 2023 •
edited
Loading

Moves the rendering logic from svelte.dev here, to be used by kit.svelte.dev as well

Related PRs:
sveltejs/svelte#8757
sveltejs/kit#10187

@changeset-bot
Copy link

changeset-bot bot commented Jun 19, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 4fb94d1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@PuruVJ PuruVJ marked this pull request as ready for review June 21, 2023 21:12
benmccann
benmccann reviewed Jun 21, 2023
View reviewed changes
packages/site-kit/src/lib/markdown/renderer.js Outdated
throw new Error('Unhandled @type JsDoc->TS conversion: ' + js_code);
}
} else if (ts.isJSDocParameterTag(tag) && ts.isFunctionDeclaration(node)) {
// if (node.parameters.length !== 1) {
Copy link
Member

Choose a reason for hiding this comment

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

remove this? or add a comment about why it's disabled

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Removed!

benmccann
benmccann approved these changes Jun 21, 2023
View reviewed changes
Copy link
Member

@benmccann benmccann left a comment

Choose a reason for hiding this comment

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

I think some tests could be helpful at some point. I'm a little worried about modifying it since it affects multiple different sites with slightly different setups. But that can be a post-launch item

@PuruVJ
Copy link
Collaborator Author

PuruVJ commented Jun 21, 2023

Ah yeah, tests are reallyyyy needed for this stuff, its too complicated and brittle. That is the cost of serving 2 sites at once though. Post launch, hopefully we can modify this logic to have learn.svelte.dev also be able to use it, with the weird +++ and --- syntax

@benmccann benmccann merged commit 9e5bf25 into master Jun 21, 2023
@benmccann benmccann deleted the feat/markdown-renderer branch June 21, 2023 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benmccann benmccann benmccann approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PuruVJ @benmccann