Add width argument to Documenter

[efaulhaber]

Closes #34.

@ericphanson I managed to add the argument, but I'm afraid I need a little more help here.

The width is now larger than before, and the lines are not wrapped anymore. However, the terminal itself is still the same size and the font as well, which means that the lines are clipped now.
Is there a way to make this work as intended? Thanks!

[ericphanson]

thanks for the PR!

I think there are two sides to it:

• constructing .cast files with a specified width <-- what your PR does
• changing the width of the "player" object <-- what is missing

The "player" object for documenter is made by the html/javascript code here:

Asciicast.jl/src/Asciicast.jl

Lines 165 to 168 in 579da86

	AsciinemaPlayer.create(
	'data:text/plain;base64,$(base64_str)',
	document.getElementById('$(name)'), {autoPlay: true, fit: false, loop: $(cast.loop)}
	);

I think. We need to somehow customize the width. I see the js player object does have configuation including cols: https://docs.asciinema.org/manual/player/options/. So I think what you need to do is read the width from the Cast object and use it in AsciinemaPlayer.create to also set the cols of the player.

[efaulhaber]

That was very helpful, thanks!
It turned out that the option fit was the problem, which was set to fit: false.

I now set it to fit: "width" and it works as intended:

The window is still the same size in the docs, but the font appears smaller.

[efaulhaber]

Ready for review now 👍

[efaulhaber]

Any news on this?

[ericphanson]

Could you add an example to the documentation to show the usage width kwarg? That would also at least run the code during the tests so if it errors in the future, the docs will stop building and I will know something is wrong

Also, I have the vague feeling I set fit = false on purpose, but I no longer remember why...

[ericphanson]

ah, looks like there is some documenter issue with width on this PR:

ERROR: LoadError: UndefVarError: `width` not defined in local scope

https://github.com/ericphanson/Asciicast.jl/actions/runs/11937572536/job/33542889591?pr=35#step:4:180

[ericphanson]

sorry for the delay! my notifications have been kinda swamped