docs: add ability to publish PDF (#146)

Signed-off-by: Ramkumar Chinchani <[email protected]>

.github/workflows/deploy.yml

@@ -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

mkdocs.yml

@@ -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
@@ -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

requirements.txt

@@ -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