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

[Feat] Extend current markdoc support #15

Open
Adammatthiesen opened this issue May 1, 2024 · 12 comments · May be fixed by #127
Open

[Feat] Extend current markdoc support #15

Adammatthiesen opened this issue May 1, 2024 · 12 comments · May be fixed by #127
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Adammatthiesen
Copy link
Member

Adammatthiesen commented May 1, 2024

Currently our markdoc parser is the most simple version of the markdoc parser, I would love to see this extended to be a more feature rich markdoc configuration. as well as allowing the End-User to be able to extend the options similar to how the marked parser is configured.

@Adammatthiesen Adammatthiesen added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers and removed help wanted Extra attention is needed labels May 1, 2024
@pietrodev07
Copy link

Hi, I'd like to take care of it!

@Adammatthiesen
Copy link
Member Author

Hi, I'd like to take care of it!

@pietrodev07 We cant wait to see what you come up with... I know we had some conversation about the start that you showed and the direction we would like to keep in mind(not depending on external frameworks as a requirement and being a HTML first setup) Anything we can do to make it easier for users to configure would be amazing... I know the @astrojs/markdoc package has some good config options... but the last time i tried to duplicate anything from that my parser just kind of decided to say "No, I am not going to work like this"

So i would say keep focus on sane defaults (if your setting up extensions similar to how my Marked parser is configured) as well as allowing the user to configure custom options for nodes/HTML-vs-React/etc.

Again, Thanks for reaching out and offering to take on this task! We all know how hard it can be for a new project to get started and bring on new contributors to help build a project!

If you have any questions along the way you can always submit what you have so far as a PR and let us know the issues your facing or what you might need help with 😄

@jdtjenkins
Copy link
Contributor

@pietrodev07 feel free to PR what you have so far and we can tweak it as we go! It might be easier if we can see what you're doing and you can ask questions on it too

@dreyfus92
Copy link
Member

As a side note, I'd like that this submission adds a bit of e2e testing.

@pietrodev07
Copy link

Hi, I'd like to take care of it!

@pietrodev07 We cant wait to see what you come up with... I know we had some conversation about the start that you showed and the direction we would like to keep in mind(not depending on external frameworks as a requirement and being a HTML first setup) Anything we can do to make it easier for users to configure would be amazing... I know the @astrojs/markdoc package has some good config options... but the last time i tried to duplicate anything from that my parser just kind of decided to say "No, I am not going to work like this"

So i would say keep focus on sane defaults (if your setting up extensions similar to how my Marked parser is configured) as well as allowing the user to configure custom options for nodes/HTML-vs-React/etc.

Again, Thanks for reaching out and offering to take on this task! We all know how hard it can be for a new project to get started and bring on new contributors to help build a project!

If you have any questions along the way you can always submit what you have so far as a PR and let us know the issues your facing or what you might need help with 😄

Yeah, thank you for all suggestions!

@pietrodev07
Copy link

@pietrodev07 feel free to PR what you have so far and we can tweak it as we go! It might be easier if we can see what you're doing and you can ask questions on it too

Yeah, now I'm opening a new PR with I have so far!

@pietrodev07
Copy link

pietrodev07 commented May 4, 2024

@Adammatthiesen @jdtjenkins is there a naming convention for branches in this repository?

@Adammatthiesen
Copy link
Member Author

The CreateIssueBranch bot is configured to use the branch naming convention issue000 where 000 is replaced with the issue number, i.e. issue0015

@pietrodev07
Copy link

The CreateIssueBranch bot is configured to use the branch naming convention issue000 where 000 is replaced with the issue number, i.e. issue0015

Thank you so much!

@Adammatthiesen Adammatthiesen pinned this issue May 6, 2024
@Adammatthiesen Adammatthiesen unpinned this issue May 6, 2024
@Adammatthiesen
Copy link
Member Author

Adammatthiesen commented Jun 5, 2024

The CreateIssueBranch bot is configured to use the branch naming convention issue000 where 000 is replaced with the issue number, i.e. issue0015

Thank you so much!

Hey @pietrodev07, were you still interested in helping with this issue?

@pietrodev07
Copy link

yes, I'll do a basic pull request by tomorrow 💪

@Adammatthiesen
Copy link
Member Author

yes, I'll do a basic pull request by tomorrow 💪

We will also be on Discord later, feel free to join any open chat and ask questions or just hang out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
4 participants