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

Improve docs markdown generation, allow example and extended #26

Merged
merged 5 commits into from
Jul 3, 2024

Conversation

carlopi
Copy link
Collaborator

@carlopi carlopi commented Jul 3, 2024

Add possibility for extension to have two extra fields in the descriptor file:

  • docs.hello_world: an optional SQL based example of what capabilities the extension provides
  • docs.extension_description: allow to pass an optional extra paragraph (markdown enabled) to describe / provide additional context on the extension

That allows to generate markdown files, that once passed down to the website generation outputs something like:
image

HTML side improvements have to be made, but those are orthogonal on deciding what content should be there.

extensions/quack/description.yml Outdated Show resolved Hide resolved
Co-authored-by: Sam Ansmink <samansmink@hotmail.com>
@carlopi carlopi merged commit fda37d9 into duckdb:main Jul 3, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

None yet

2 participants