Wall-E
(Raphael)
1
我想帮助以下 Python 框架的开发人员,使其与我们的 Discourse 实例的 onebox 功能兼容,从而推广该框架:
https://docs.sunpy.org/en/v3.0.0/whatsnew/3.0.html
那么,什么样的网站才能与 onebox 兼容呢?我在谷歌上搜索了 onebox,并找到了这个 GitHub 页面:https://github.com/discourse/onebox。不过,对于我所提到的框架,他们使用 Sphinx 来自动生成部分页面。因此,开发人员是否可以通过设置某些 Sphinx 选项,使其页面与 onebox 兼容?
Falco
(Falco)
2
如果你在一行中单独尝试链接 https://docs.sunpy.org/en/v3.0.0/whatsnew/3.0.html,你将看到以下消息:
抱歉,我们无法为该网页生成预览,因为找不到以下 oEmbed / OpenGraph 标签:description、image
该页面的 description OpenGraph 元标签为空,因此我们无法嵌入它。此外,它还为其他一些 OpenGraph 标签(如 image 和 url)使用了相对 URL,我不确定这是否受支持。
Wall-E
(Raphael)
3
所以我已将相关信息转发给 SunPy 开发团队。他们针对此页面测试了一个修复方案:https://sunpy--5366.org.readthedocs.build/en/5366/。opengraph.xyz 验证结果显示,所有标签均已在 HTML 文件中定义:
<!-- HTML Meta Tags -->
<title>SunPy Documentation</title>
<meta name="description" content="SunPy Documentation">
<!-- Facebook Meta Tags -->
<meta property="og:description" content="SunPy Documentation">
<meta property="og:image" content="https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpy_logo_word.png" />
<meta property="og:site_name" content="SunPy Documentation" />
<meta property="og:title" content="SunPy Documentation">
<meta property="og:type" content="website">
<meta property="og:url" content="https://docs.sunpy.org/en/stable//index.html" />
<!-- Twitter Meta Tags -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:description" content="SunPy Documentation">
<meta name="twitter:image" content="https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpy_logo_word.png">
<meta name="twitter:title" content="SunPy Documentation">
<meta property="twitter:domain" content="https://docs.sunpy.org/en/stable/">
<meta property="twitter:url" content="https://docs.sunpy.org/en/stable//index.html">
尽管如此,在我们的 Discourse 实例中仍然无法正常工作,依旧报错:oEmbed / OpenGraph tags could not be found:description, image
他们是否遗漏了什么?这是我们关于此问题的 GitHub 讨论线程:onebox-compatible documentation for promoting SunPy's features and updates · Issue #5362 · sunpy/sunpy · GitHub
这真的是一个有效的条目吗?描述应该更长,并包含页面实际内容的一部分,而不是像“SunPy 文档”这样的占位符。
riking
(Kane York)
5
描述被忽略了,因为它与标题完全相同。您应该从内容中提取相关部分填入描述属性。