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

adding a section on why this instead of directly quarto #34

Open
jcolomb opened this issue Aug 12, 2024 · 1 comment
Open

adding a section on why this instead of directly quarto #34

jcolomb opened this issue Aug 12, 2024 · 1 comment

Comments

@jcolomb
Copy link

jcolomb commented Aug 12, 2024

Hello,

I see you have a good section on why using this plugin when you are already using mkdocs.

If I am new, what are the advantages of using this instead of just using quarto directly (quarto can also create documentation website)?

(I would make a PR, but I do not know the answer)

@jspaezp
Copy link
Owner

jspaezp commented Aug 29, 2024

Hey there! Thanks for the interest in the project!

That is a good point! I will add that next when I update this guy.
Long story short... quarto is a markdown based format that allow execution of the code and captures the result.

My use case is that usually when I need to document a package, I would need to write the code and the expected output, with quarto I can write the code and the output gets generated for me!

The cool thing here is that I can sync the documentation of mkdocs with the build process of quarto. Then everything gets handled for me internally ... links between docs, theming, build process. Instead of me having to handle the sync manually.

Best!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants