Skip to content

Create an official pdoc badge for Github READMEs #835

@joshdavham

Description

@joshdavham

Problem Description

I'd like to add a badge in my project's README that links to my pdoc documentation. I'm not sure how to style my badge as there doesn't seem to be an official pdoc badge.

Proposal

I would like for their to be an official pdoc badge/shield that developers can put in their READMEs as an easy (and aesthetic) link to their pdoc documenation. Such a badge seems to already exist for autofix.ci (and it looks great!)

Alternatives

I'm considering just reusing something like the current pdoc badge in this project's README, but having it say docs | my-project-name instead of docs | pdoc.dev.

Additional context

Image

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions