Skip to content

Release version with documentation included #29

@tfiers

Description

@tfiers

Thanks for this great project.
I wondered if a release version with offline documentation included would be possible to add?

Maybe named something like TinyTeX-doc.

Why

I agree with the reasoning for excluding documentation given in the faq by @yihui: almost everyone just googles how to do something (mostly arriving at the great knowledgebase that is tex.stackexchange.com)
But sometimes you work where there is no internet (like on public transport or in nature).

And on "you probably don’t even know where to find these documentation files on your computer": yes, but:
with the great LaTeX-Workshop extension for VS Code, local documentation is actually easily discoverable, thanks to a handy hover popup on \usepackage{name}.
(In fact, the impetus for writing this issue was me adding a link to TinyTeX in the wiki of LaTeX-Workshop).

Alternatives

There is indeed the tlmgr installl --reinstall --with-doc <PKG> command mentioned by @norbusan here.
But you would have to do this for every already installed package then.
And you'd have to remember to add the --with-doc option when installing new packages.

Increased bundle size

Adding offline documentation will indeed increase the bundle size.
But it will still be considerably smaller than the full TeX Live distribution with it's 4000+ packages.

A rough estimate for the increased release size:

With the 231 MB TinyTeX.zip distribution (513 MB unzipped),
and using tlmgr info --only-installed, I get 312 installed packages.
Say that an average documentation pdf is 250 KB.
..The offline docs would then be 78 MB. 1

How

Qua implementation, I'm not entirely sure how the build process works; though it seems we'd need
to omit option_doc 0 in tinytex.profile (or set it to option_doc 1).



Footnotes

  1. This is an increase of 15% to the unzipped size.
    The increase to the zip size would probably be larger however: pdf's are often already compressed internally.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions