本页内容

Guidedog / 文档 0.2.0

图片、视频、音频与下载

将资源放在解释它的文档附近，使用相对路径；若以 / 开头，则相对于源目录。Guidedog 会复制文档使用的资源。视频在网页上仍可播放；PDF 则标明该录制内容。

图片

.. image:: diagrams/pipeline.png
   :alt: The build pipeline
   :width: 480px

.. figure:: /screenshots/search.png

   Searching the site.

页面将图片复制到 _images，图书则将其嵌入。两种输出均支持 PNG、JPEG、GIF、SVG 和 WebP。图片缺失会产生警告：页面保留替代文本，图书省略图片。

视频与音频

指向视频（.mp4、.webm、.ogv、.mov、.m4v）或音频（.mp3、.ogg、.oga、.m4a、.opus、.wav、.flac、.aac）的 image 或 figure 指令会播放媒体；Docutils 对视频也采用此方式：

.. figure:: media/tour.mp4
   :alt: A tour of the site
   :width: 640

   The two-minute tour.

.. image:: media/pronunciation.mp3

页面显示浏览器播放器，并提供文件链接，供无法播放的浏览器使用。图书不能播放媒体，因此在播放器所在位置用方框标明录制内容；文本输出则写为 [video: ...] 或 [audio: ...]。

下载

download 角色可链接任意文件，并将其复制到 _downloads：

Get :download:`the example project <examples/project.zip>`.

主题文件

_static 保存主题使用的样式表、脚本、字体和徽标，并原样复制到站点的 _static。html_static_path 列出该目录；html_css_files、html_js_files、html_logo 和 html_favicon 指定其中的文件。内容媒体应与文档放在一起，这样移动文档和媒体后，链接仍有效。