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

Fix Tauri Config Generator #1472

Closed
Tracked by #1344
lorenzolewis opened this issue Sep 3, 2023 · 2 comments
Closed
Tracked by #1344

Fix Tauri Config Generator #1472

lorenzolewis opened this issue Sep 3, 2023 · 2 comments
Milestone

Comments

@lorenzolewis
Copy link
Member

The generator that builds https://beta.tauri.app/2/reference/config/ is currently broken. Would like to switch over to something like https://github.com/adobe/jsonschema2md or similar so that we don't need to maintain the current generator at https://github.com/tauri-apps/tauri-docs/blob/next/src/plugins/configGenerator.ts

@vasfvitor
Copy link
Contributor

I've tried both, barely, just to play around https://github.com/adobe/jsonschema2md and https://github.com/BrianWendt/json-schema-md-doc.

The issue with jsonschema2md is that it creates multiples md files: adobe/jsonschema2md#531 and I had to add an $id field to the original schema. Plus it's made to schema 2019-09. (I know next to nothing about json schema)

Concatenating all the contents to the same file the output will have broken links/anchors, a infinitely long nav sidebar, a mess overall.

json-schema-md-doc worked better out of the box, it supports solely draft-7. But it throws a bunch of 'unknown prop type' warnings on option types like ['string', 'null'], [ 'array', 'null' ].. Output still broken tho but at first glance seems better, yet incomplete. Note that is a way smaller project, it's only a js file.

For reference:
minimal code for adobe/jsonschema2md: vasfvitor@c54ded5

minimal code for json-schema-md-doc: vasfvitor@7c5c12f

In both it's commited the original config.md file to compare with the generated config.md output

@lorenzolewis
Copy link
Member Author

Fixed by #1713 , although there are future enhancements that we would like to put in place for a more streamlined UX as noted in that PR.

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