alhassy / alhassy/org-special-block-extras

Links do not properly render their docs' documentation

未關閉
#54 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
HTML
星號
236
分支
17
PR 合併指標
30 天內沒有已合併 PR

描述

I created this simple block called `admonition`:

``` elisp
(org-defblock
admonition (type nil title nil)
nil
"Enclose text in a box denoting an admonition.

== HTML ==

In HTML, this creates a \\=`section' element with the class
admonition-TYPE, where TYPE is the main arg. Under it is a
\\=`h3'--TYPE and TITLE are included (the latter only if it
is specified).

By default, no styling is applied; it has to be done
manually. This can be done with a stylesheet applying a
style to the right class.

\(fn TYPE [:title TITLE])"
(pcase backend
('html
(let* ((prefix (capitalize (or type "note")))
(title (if title (format "%s: %s" prefix title)
prefix)))
(format "

%s

%s"
type title contents)))))
```

Then I use it in my Org file:

``` org
doc:org-block/admonition

#+begin_admonition notice
Right now, Foo is the only site supported by {{{name}}}. This will likely change in the future when this project has taken shape and is out of alpha.
#+end_admonition
```

When I hover my mouse over the doc link, I get this tooltip:

> [org-block/admonition] org-block/admonition ::
>
> (fn ARG0 ARG &rest ARGS)

The result of

``` elisp
(org-docs-get "org-block/admonition")
```

returns something equally useless. So what's the problem? Am I doing something wrong or is this a bug?

貢獻指南

這個儲存庫沒有索引到貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。