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

Mention fig.alt in the docs #8

Closed
hturner opened this issue May 30, 2024 · 5 comments
Closed

Mention fig.alt in the docs #8

hturner opened this issue May 30, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@hturner
Copy link

hturner commented May 30, 2024

I'm happy to see that fig.alt is supported by litedown, but there is no mention of it in the docs. Since this was not always possible with rmarkdown I think it is worth including in an example or mentioning explicitly somewhere.

@yihui
Copy link
Owner

yihui commented May 30, 2024

Yes, the documentation needs a lot more work (which may take two months). Not only fig.alt, but most chunk options are not documented yet.

@yihui yihui added the documentation Improvements or additions to documentation label May 30, 2024
@TimTaylor
Copy link
Contributor

Related - now there is the litedown.fig.alt option, it would be useful to add some documentation on it to fuse().

@yihui - I'd be happy to submit a documentation patch for fuse() if useful (perhaps adding a 'global options' section to the help file).

@yihui yihui closed this as completed in 1dd823d Nov 25, 2024
@yihui
Copy link
Owner

yihui commented Nov 25, 2024

I've finally finished documenting all chunk options (my brain hurts now). Unfortunately GIthub Action on macOS is currently broken so the website can't be automatically deployed. I'm not sure when it will resume. You can clone the repo and preview the docs by yourself:

install.packages(c('litedown', 'xfun'), repos = 'https://yihui.r-universe.dev')
# then run litedown::roam() in this package's root directory

@remlapmot
Copy link

If you want an immediate fix - there is a workaround to fix the macOS action r-lib/actions#948 (comment)

@yihui
Copy link
Owner

yihui commented Nov 25, 2024

@remlapmot Thank you! It seems they have applied the workaround in the setup-r action: r-lib/actions#953 I just re-ran the action and it worked.

@hturner @TimTaylor fig.alt is documented at https://yihui.org/litedown/#sec:option-fig

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

No branches or pull requests

4 participants