Skip to content

Enable code block copy button on documentation site #212

@MariusStorhaug

Description

Context

The PSModule documentation site (psmodule.io) renders code blocks from the README and other documentation pages. Users need to be able to copy code snippets easily to use them in their own scripts.

Request

Code blocks on the documentation site should have a copy button so users can quickly copy the code content to their clipboard.

Screenshot showing code blocks without copy functionality

Acceptance criteria

  • Code blocks on the documentation site have a visible copy button
  • Clicking the copy button copies the code content to the clipboard
  • The feature works across all documentation pages

Technical decisions

Approach: Material for MkDocs (and Zensical) support the code copy feature via the content.code.copy configuration in mkdocs.yml.


Implementation plan

  • Enable content.code.copy: true in the mkdocs.yml theme features
  • Verify the copy button appears on code blocks in the built documentation
  • Test across different page types (README, function docs, examples)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions