Skip to content

Clarify plugin requirements in CONTRIBUTING.md #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sn1kk3r5 merged 1 commit into from
Mar 5, 2026
Merged

Clarify plugin requirements in CONTRIBUTING.md #187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,15 @@ Minor changes can be easily previewed within your Markdown editor.

### Plugins

Two plugins are specified in the requirements.txt
Four plugins/extensions are specified in the requirements.txt

- mkdocs-caption == 0.0.9
- mkdocs-git-revision-date-localized-plugin == 1.2.1
- mkdocs-material == 9.6.12
- pymdown-extensions == 10.16.1

The `mkdocs-caption` is needed to insert numbered figure captions on pages. The second plugin will add 'Last update: month, day, year' at the bottom of each page.

The `mkdocs-caption` is needed to insert numbered figure captions on pages. The second plugin `revision-date` will add 'Last update: month, day, year' at the bottom of each page. `material` is being used for navigation, search, and table of contents. `pymdown-extensions` is used for headlines, codeblocks, links, and pictures.

### Version control
Since the Portfolio Performance manual is being maintained in GitHub, version control is already in place. Please pay special attention to the following:
Expand Down