add example of adding HTML tag to scribble output
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
未指定文件或测试。先查看提议的 Scribble 示例和现有文档位置，然后选择能够展示 HTML 标签输出和嵌套的合适位置及示例；完成标准是列出的两项任务都已完成。
由索引模型根据 Issue 内容生成。
描述
I agree about the need for some kind of doc update. Outputting a specific HTML tag is a basic task and the answer is hard to find.
Maybe Scribble needs an FAQ, maybe we can get by with more indexing.
Originally posted by @bennn in https://github.com/racket/scribble/issues/233#issuecomment-636227679
tasks
- Choose suitable locations for examples
- choose suitable examples
Possible example (shows HTML tag nesting):
#lang scribble/base
@(require
(only-in scribble/core make-style)
(only-in scribble/html-properties alt-tag))
@(define details-style (make-style #f (list (alt-tag "details"))))
;summary
@(define summary-style (make-style #f (list (alt-tag "summary"))))
@(define (details summary . arg*)
(apply elem (elem summary #:style summary-style) #:style details-style arg*))
@; -----------------------------------------------------------------------------
This is a Scribble document with a @tt{details} element.
@details["the details heading"]{
The @tt{alt-tag} style property can change the HTML tag that
Scribble creates for an @tt{element} or @tt{paragraph}.
@url{https://docs.racket-lang.org/scribble/core.html#(def._((lib._scribble%2Fhtml-properties..rkt)._alt-tag))}
}
- 主要语言
- Racket
- 星标
- 250
- 派生
- 102
- 平均合并
- 11 天 9 小时
- 30 天内合并 PR
- 2
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
racket/scribble 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 3/5 1-2 天 新手友好度 74/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
难度 3/5 1-2 天 新手友好度 55/100
-
难度 4/5 3-5 天 新手友好度 35/100
相似的 Issue
-
sync-en
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
sync-en
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 4 天内回复
-
[oblt-aw][autodoc] Update user onboarding guide for mandatory trigger CODEOWNERS step可能已有人在做 @github-actions 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 1 天内回复
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 72/100
graygarbage/HermesKey#20 ·
-
8.9 to 8.10 Helm upgrade guide still says deprecated keys are removed in chart v16 (Camunda 8.11)未关闭
难度 1/5 1 小时以内 新手友好度 78/100
camunda/camunda-platform-helm#7559 ·
维护者通常 1 天内回复