UCL-ARC / UCL-ARC/mkdocs-rc-docs
Incorporate copy button for shell script and other code snippets in the docs
Nobody has claimed this yet.
- Dominant language
- Rich Text Format
- Stars
- 41
- Forks
- 22
- Avg merge
- 1m
- Merged PRs (30d)
- 14
Description
mkdocs for material comes with a new copy code button that makes it easy to copy code such as those given in the example job scripts page here.
Achieving this requires just a simple yaml config update as per their docs here (not sure from which version of mkdocs was that feature incorporated).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the repository's MkDocs YAML configuration and the linked Material for MkDocs code-block documentation, then confirm whether the installed version supports the copy-button setting. Enable the setting and verify that code snippets on the Example Jobscripts documentation page display a working copy button.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100