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

Document all public functions from quarto Lua API #4499

Open
cderv opened this issue Jan 19, 2023 · 1 comment
Open

Document all public functions from quarto Lua API #4499

cderv opened this issue Jan 19, 2023 · 1 comment
Assignees
Labels
documentation Doc improvements & quarto-web
Milestone

Comments

@cderv
Copy link
Collaborator

cderv commented Jan 19, 2023

About those new function missing in our doc

quarto.doc.input_file
quarto.doc.output_file

Yep, it will available to any LUA code that is being executed (e.g. filter or shortcode)- it is public but you're right that it is omitted from the documentation (unintentionally)!

We also added some project related functions that are omitted:

quarto.project.directory
quarto.project.offset
quarto.project.profile
quarto.project.output_directory

Let's keep this issue open to track getting the documentation updated to reflect this.

Originally posted by @dragonstyle in #2249 (comment)

@cderv cderv added the documentation Doc improvements & quarto-web label Jan 19, 2023
@dragonstyle dragonstyle transferred this issue from quarto-dev/quarto-web Feb 23, 2023
@cwickham cwickham added this to the v1.4 milestone Mar 9, 2023
@cwickham
Copy link
Collaborator

Relevant doc page: https://quarto.org/docs/extensions/lua-api.html#quarto-lua-api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Doc improvements & quarto-web
Projects
None yet
Development

No branches or pull requests

2 participants