Unexpected behavior when developing revealjs-plugin extension, suggest imporved docs on `config` key.
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 半天
- 新手友好度
- 64/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
从 RevealJS-Plugins 文档开始，尤其是插件配置部分，并将其与链接的 Advanced Reveal 插件示例以及 _extension.yml/plugin.yml 结构进行比较。记录 config 键可以启用从 pres.qmd 读取用户选项，包括相关的放置位置和一个示例；链接的文档应明确说明此行为。
由索引模型根据 Issue 内容生成。
描述
What would you like to do?
Report an issue on quarto.org
Description
I'm currently developing a revealjs-plugin extension. Currently, $ quarto create extension revealjs-plugin creates an _extension.yml folder, as described in Quarto Docs > Extensions > RevealJS-Plugins. The configuration section of this page uses the following language:
Note that when packaging an existing Revealjs plugin, you can override its default configuration using the config key within your _extension.yml file. For example, these are the overrides provided by the pointer extension:
However, this doesn't document the fact that if you don't pass a config: ext-name: <foo> key into this file, then quarto will not read the options from a users pres.qmd yaml. For example, suppose I am adding functionality to an extension, ext. I have set defaults for my added features in the extension internals, and I'm not changing the pre-existing defaults otherwise. Based on the docs, I wouldn't think of a need to pass the defaults to _extension.yml to expose these feature options to the user. However, in my pres.qmd, under format: > revealjs:, the extension relevant keys, say:
ext:
new-feature:
width: 333
height: -10
pre-existing-feature: false
are not processed by Quarto. On the other hand, including the following in _extension.yml > contributes: > revealjs-plugins: (inline with the - name: ext key)
config:
ext: "meaningless string"
allows for any of the aforementioned keys to work in pres.qmd. This behavior is reasonable, the _extension's config: ext key tells Quarto to listen for user options, I just think it would be helpful to document that with more explicit language.
Relatedly, the Quarto Docs > Presentations > Revealjs > Advanced Reveal #Plugins page describes using a plugin.yml file with a similar yet slightly simplified structure as compared to _extension.yml. I assume this is for personal (vs. distributed, as a Quarto extension) use of reveal plugins, but I'm mainly just including it so you know I've read it. It seems like the config: > plugin: keys work similarly in the linked source code examples.
- 主要语言
- JavaScript
- 星标
- 6k
- 派生
- 461
- 平均合并
- 13 小时 52 分钟
- 30 天内合并 PR
- 52
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
quarto-dev/quarto-cli 的其他 Issue
-
accessibility documentation
难度 1/5 1 小时以内 新手友好度 90/100
quarto-dev/quarto-cli#14944 ·
维护者通常 1 天内回复
-
maintenance ojs-engine
难度 2/5 1-3 小时 新手友好度 65/100
quarto-dev/quarto-cli#14934 ·
维护者通常 1 天内回复
-
accessibility bug html themes
难度 2/5 1-3 小时 新手友好度 75/100
quarto-dev/quarto-cli#14932 ·
维护者通常 1 天内回复
-
documentation
难度 2/5 1-3 小时 新手友好度 86/100
quarto-dev/quarto-cli#14915 ·
维护者通常 1 天内回复
-
binder bug
难度 1/5 1 小时以内 新手友好度 92/100
quarto-dev/quarto-cli#14907 · 3 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
查看 quarto-dev/quarto-cli 的全部 Issue
相似的 Issue
-
Design only Leadership Survey SLFS
难度 2/5 1-3 小时 新手友好度 70/100
bcgov/digital-journeys#2293 ·
-
Toolkit
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
API Bug
难度 2/5 1-3 小时 新手友好度 78/100
ProjectSidewalk/SidewalkWebpage#5556 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
jessepollak/home#1454 ·
维护者通常 1 天内回复
-
Mend: dependency security vulnerability untriaged
难度 2/5 1-3 小时 新手友好度 64/100
opensearch-project/OpenSearch-Dashboards#12822 ·
维护者通常 1 天内回复