Skip to content

[Documentation Suggestion] Provide a PDF version of the docs #394

@Al3cLee

Description

@Al3cLee

Hello, thanks for this nice package and a very good documentation! I wanted to learn from the docs today and compiled a PDF version of it via DocumenterTypst.jl.

During the process the only change to be made was simply replace the raw html-style images with standard markdown image syntax

![caption](relative path)

where relative path means: for docs/src/man/symmetries.md file which wants to show an image docs/src/man/img/tree-summary.svg, the link appearing in the markdown file should be ![summary](img/tree-summary.svg). Therefore, it should be quite easy to automate the generation of a PDF file as a workflow.

I didn't think this alone was worth a PR, so I am just opening an issue to see whether you're interested in linking to a PDF version in the documentation; the docs are suitable for long-form reading and I've already printed a copy, haha.

The PDF file is around 2.6MB in size, which wouldn't be a burden for the website. It is available at: https://static.wentaoli.xyz/TensorKit.jl.pdf.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions