Skip to content

add: build support for doc file (.mdx,.md) #538

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
Closed
Asuniia wants to merge 2 commits into from
Closed

add: build support for doc file (.mdx,.md) #538

Asuniia wants to merge 2 commits into from

Conversation

@Asuniia
Copy link
Contributor

@Asuniia Asuniia commented Apr 23, 2025

I simply copied what had been done for the tests, in order to include the .md and .mdx extensions in the build.

@changeset-bot
Copy link

changeset-bot bot commented Apr 23, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 7a025d3

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.

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

ieedan
ieedan previously approved these changes Apr 23, 2025
View reviewed changes
@ieedan ieedan self-requested a review April 23, 2025 14:21
@pkg-pr-new
Copy link

pkg-pr-new bot commented Apr 23, 2025

Open in StackBlitz

pnpm dlx https://pkg.pr.new/jsrepojs/jsrepo@538

commit: be1d290

@ieedan ieedan dismissed their stale review April 23, 2025 14:21

Accident

@ieedan
Copy link
Collaborator

ieedan commented Apr 23, 2025

This looks good minus the one comment as far as the build side goes.

I think we should add a includeDocs option in the config as well as a zero-config prompt for it.

@ieedan ieedan linked an issue Apr 23, 2025 that may be closed by this pull request
feat: Allow doc files (.md, .md) to be included with registry #537
Closed
1 task
@Asuniia
Copy link
Contributor Author

Asuniia commented Apr 24, 2025

image

I've taken the liberty of adding a block documentation coverage feature. If you don't like it, you can ignore it.

@ieedan
Copy link
Collaborator

ieedan commented Apr 24, 2025

image I've taken the liberty of adding a block documentation coverage feature. If you don't like it, you can ignore it.

This is actually pretty neat I think we can keep that 😊

@ieedan
Copy link
Collaborator

ieedan commented Apr 24, 2025

So the --include-docs should be part of the client install. The build can always include it and users will just decide weather or not they want to install the docs during initialization. (with a default of off)

ieedan
ieedan reviewed Apr 24, 2025
View reviewed changes
src/utils/build/index.ts
return v.parse(v.array(categorySchema), JSON.parse(fs.readFileSync(outputFilePath).toString()));
}

export function documentationCoverage(categories: Category[]) {
Copy link
Collaborator

@ieedan ieedan Apr 24, 2025

Choose a reason for hiding this comment

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

lets move this to /utils/prompts cause it fits better context wise there

@ieedan
Copy link
Collaborator

ieedan commented Apr 24, 2025

Sorry it wasn't my intention to wait all day to review this but I was busy and ended up forgetting 😅

@ieedan ieedan mentioned this pull request Jun 11, 2025
Merged
@ieedan
Copy link
Collaborator

ieedan commented Jun 11, 2025

Closing this in favor of #577

@ieedan ieedan closed this Jun 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ieedan ieedan ieedan left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

feat: Allow doc files (.md, .md) to be included with registry

2 participants

@Asuniia @ieedan