Skip to content

Provide (Easily) Searchable Offline Format #275

@rwinch

Description

@rwinch

Spring supports a zip file of the docs for download, but it is not simple for users to search that content.

An alternative might be an HTML Single, PDF, or EPub.

I have reservations about a PDF or EPub because, historically, it has been difficult to maintain the PDF documentation quality and the use (we looked up the download numbers) of these formats does not justify the effort to maintain additional formats. Instead, I think an HTML Single would be preferred as it doesn't require the dual maintenance making it easier to ensure a quality document. Users who want can print it to PDF.

The HTML Single will likely only be available for download and not directly linkable. This is to ensure that external pages link only to the multi page documentation which improves SEO of the multi page documentation, browser load times, etc.

For this work to start, we are tracking #users > Antora PDF extension in the works @ 💬

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions