问如何在github页面上mkdocs生成的网站中嵌入本地pdf文件？

EN

解决方案

在发布的站点上提供pdf文件的主要挑战是创建一个没有损坏的链接，并从存储库中实际访问该文件。

Mkdocs附带了许多扩展，增强了框架的功能。您需要使用pymdownx.pathconverter来解决这个问题。

示例

我已经模糊了截图中的内容。但是你可以看到嵌入的pdf文件是什么样子的。

​

​

下面是你需要处理的部分。

A.安装PyMdown扩展程序

和其他人一样必须..。

pip install \
    mkdocs \
    mkdocs-material \
    mkdocs-material-extensions \
    pymdown-extensions 

B.更新mkdocs.yml

将以下内容添加到mkdocs.yml

# Strategy: Use an absolute path
markdown_extensions:
  - pymdownx.pathconverter:
      base_path: 'YOUR_REPO_NAME' # default: ''
      relative_path: '' # default ''
      absolute: true # default: false
      tags: 'a script img link object embed'

读者注意:您还可以在pymdownx.pathconverter中使用相对路径。有关详情，请参阅文件。但是，为了简洁起见，如果您最终使用了相对路径，您需要这样做：

pymdownx.pathconverter.扩展设置中的

1. 设置absolute: false

1. 使用相对路径(这应该考虑到您的URL路径层次结构)。例如，如果将pdf-file docs/artifacts/file.pdf嵌入到标记文件docs/howto/embedding_pdf.md中，并且指向标记文件的链接看起来类似于http://localhost:8000/demo_mkdocs_project/howto/embedding-a-pdf-file (请参阅以下章节以获得更多的上下文)，则文件嵌入时的相对路径将类似于：

。

"../../artifacts/file.pdf"

C.从存储库嵌入PDF文件

在这里，我们假设pdf文件位于：docs/artifacts/file.pdf，而docs文件夹位于存储库的根目录。在下面的代码块中，我在文件docs/howto/embedding_pdf.md中嵌入了一个pdf。

<!--- file: docs/howto/embedding_pdf.md --->
{% with pdf_file = "artifacts/file.pdf" %}

{% set solid_filepdf = '<i class="fas fa-file-pdf"></i>' %}
{% set empty_filepdf = '<i class="far fa-file-pdf"></i>' %}

## Example: Embedding a PDF file

<object data="{{ pdf_file }}" type="application/pdf">
    <embed src="{{ pdf_file }}" type="application/pdf" />
</object>

## Example: Creating a link to a PDF file

<a href="{{ pdf_file }}" class="image fit">{{ solid_filepdf }}</a>

{% endwith %}

D.在mkdocs.yml中添加到页面的链接

这将创建一个顶级链接HowTo，然后在另一个链接Embedding a PDF file下创建。

# file: mkdocs.yml

nav:
  - Home: index.md
  - HowTo:
    - Embedding a PDF file: howto/embedding_pdf.md

这四个步骤实际上使pdf文件可以在本地服务器(localhost:8000)和github页面上使用(以防您在那里发布)。然后，指向该文件的链接将如下所示：

http://localhost:8000/demo_mkdocs_project/artifacts/file.pdf本地服务器：

http://githubid.github.io/demo_mkdocs_project/artifacts/file.pdf

• GitHub Pages：

Note：

我以为

githubid

• repository

• Git用户Git：名称：demo_mkdocs_project

参考文献

1. PyMdown Extensions Documentation -