Skip to content
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.

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

docs: add ability to publish PDF #146

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,19 @@ jobs:
git config --global user.name "${{ github.actor }}"
mike deploy --push --template go-import/redirect.html --update-aliases ${{ github.event.release.tag_name }} latest zot
mike set-default --push latest

- if: github.event_name == 'release' && github.event.action == 'published'
name: Build PDF document
run: |
mkdocs --version
mkdocs build

- if: github.event_name == 'release' && github.event.action == 'published'
name: Publish artifacts on releases
uses: svenstaro/upload-release-action@v2
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: site/pdf/document.pdf
tag: ${{ github.ref }}
overwrite: true
file_glob: true
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ site_description: Zot Registry
repo_url: https://github.com/project-zot/zot
repo_name: project-zot/zot
edit_uri: ""
copyright: Copyright &copy; 2019 - 2023 The zot project authors, All Rights Reserved. | The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href="ihttps://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a>
copyright: Copyright &copy; 2019 - 2024 The zot project authors, All Rights Reserved. | The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href="ihttps://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a>
theme:
name: material
custom_dir: material
Expand Down Expand Up @@ -50,6 +50,8 @@ plugins:
minify_html: true
- git-revision-date-localized
- macros
- with-pdf:
copyright: Copyright &copy; 2019 - 2024 The zot project authors, All Rights Reserved.
markdown_extensions:
- abbr
- admonition
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ mike==1.1.2
markdown-include==0.7.0
mkdocs-git-revision-date-localized-plugin==1.1.0
mkdocs-macros-plugin==0.7.0
mkdocs-with-pdf==0.9.3
Loading