litedown icon indicating copy to clipboard operation
litedown copied to clipboard

Mention fig.alt in the docs

Open hturner opened this issue 1 year ago • 2 comments
trafficstars

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.

hturner avatar May 30 '24 14:05 hturner

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 avatar May 30 '24 14:05 yihui

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).

TimTaylor avatar Sep 09 '24 09:09 TimTaylor

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

yihui avatar Nov 25 '24 05:11 yihui

If you want an immediate fix - there is a workaround to fix the macOS action https://github.com/r-lib/actions/issues/948#issuecomment-2495861299

remlapmot avatar Nov 25 '24 06:11 remlapmot

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

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

yihui avatar Nov 25 '24 13:11 yihui