Skip to content

Commit

Permalink
Enable social cards for documentation
Browse files Browse the repository at this point in the history
This merely enables them

Might want to customize them in the future: https://squidfunk.github.io/mkdocs-material/tutorials/social/basic/

Signed-off-by: nscuro <[email protected]>
  • Loading branch information
nscuro committed Jul 1, 2024
1 parent 685a687 commit d3c3298
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ jobs:
python-version: "3.9"
check-latest: true
- name: Install Requirements
run: pip install mkdocs-material mike
run: |-
pip install 'mkdocs-material[imaging]' mike
- name: Determine Project Version
id: determine_version
run: |-
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,7 @@ testdata/boms/generated/*.cdx.json

# nix
.direnv
.pre-commit-config.yaml
.pre-commit-config.yaml

# Material for MkDocs
.cache/
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: Hyades
site_url: https://github.com/DependencyTrack/hyades/blob/main/README.md
site_url: https://dependencytrack.github.io/hyades/latest/

repo_name: DependencyTrack/hyades
repo_url: https://github.com/DependencyTrack/hyades
Expand Down Expand Up @@ -69,6 +69,7 @@ markdown_extensions:

plugins:
- search
- social

nav:
- Getting Started:
Expand Down

0 comments on commit d3c3298

Please sign in to comment.