ELEMENTS.md

Supported elements

Details

Type	Amount	Meaning
All	98
⛔ Not Possible	5	Not possible to implement in a console context
✅ Implemented	75	Supported
📰 No Documentation	12	Not enough available information to implement
❌ Not Implemented	7	Not implemented

Element List

Index	Item	Supported?
1	abbreviation	⛔ Not Possible1
2	acronym	✅ Yes
3	address	✅ Yes
4	admonition	✅ Yes
5	attention	✅ Yes
6	attribution	✅ Yes
7	author	✅ Yes
8	authors	✅ Yes
9	block-quote	✅ Yes
10	bullet-list	✅ Yes2
11	caption	⛔ Not Possible
12	caution	✅ Yes
13	citation	✅ Yes
14	citation-reference	✅ Yes
15	classifier	✅ Yes
16	colspec	📰 No Documentation
17	comment	✅ Yes
18	compound	❌ No
19	contact	✅ Yes
20	container	📰 No Documentation
21	copyright	✅ Yes
22	danger	✅ Yes
23	date	✅ Yes
24	decoration	✅ Yes3
25	definition	✅ Yes
26	definition-list	✅ Yes
27	definition-list-item	✅ Yes
28	description	✅ Yes
29	docinfo	✅ Yes
30	doctest-block	✅ Yes
31	document	✅ Yes
32	emphasis	✅ Yes
33	entry	📰 No Documentation
34	enumerated-list	✅ Yes4
35	error	✅ Yes
36	field	✅ Yes
37	field-body	✅ Yes
38	field-list	✅ Yes
39	field-name	✅ Yes
40	figure	⛔ Not Possible
41	footer	✅ Yes
42	footnote	✅ Yes
43	footnote-reference	✅ Yes
44	generated	✅ Yes
45	header	✅ Yes
46	hint	✅ Yes
47	image	✅ Yes5
48	important	✅ Yes
49	inline	❌ No
50	label	📰 No Documentation
51	legend	📰 No Documentation
52	line	✅ Yes
53	line-block	✅ Yes
54	list-item	✅ Yes
55	literal	✅ Yes
56	literal-block	✅ Yes
57	math	⛔ Not Possible6
58	math-block	⛔ Not Possible6
59	meta	✅ Yes
60	note	✅ Yes
61	option	✅ Yes
62	option-argument	✅ Yes
63	option-group	✅ Yes
64	option-list	✅ Yes
65	option-list-item	✅ Yes
66	option-string	✅ Yes
67	organization	✅ Yes
68	paragraph	✅ Yes
69	pending	✅ Yes
70	problematic	✅ Yes
71	raw	📰 No Documentation
72	reference	📰 No Documentation
73	revision	✅ Yes
74	row	📰 No Documentation
75	rubric	✅ Yes
76	section	✅ Yes
77	sidebar	✅ Yes
78	status	✅ Yes
79	strong	✅ Yes
80	subscript	✅ Yes
81	substitution-definition	📰 No Documentation
82	substitution-reference	📰 No Documentation
83	subtitle	✅ Yes
84	superscript	✅ Yes
85	system-message	✅ Yes
86	table	❌ No
87	target	📰 No Documentation
88	tbody	❌ No
89	term	✅ Yes
90	tgroup	❌ No
91	thead	❌ No
92	tip	✅ Yes
93	title	✅ Yes
94	title-reference	📰 No Documentation
95	topic	✅ Yes
96	transition	✅ Yes
97	version	✅ Yes
98	warning	✅ Yes

Footnotes

1. Abbreviation and acronym elements work when hovering over some text, since in a terminal we can't change the hover text (as far as I know), those are not supported ↩

2. Bullet lists are supported for up to 3 levels of nesting ↩

3. Due to the way decoration works, this doesn't have any purpose inside a terminal, so decoration is skipped ↩

4. Enumerated lists are supported without nesting ↩

5. Images show an emoji and the alt text or title text (aka hover text) and they are clickable, if the image has a target link then it opens that target link when clicked, otherwise it opens the image url ↩

6. Math elements are usually written in latex. This makes it hard to show them properly in the terminal, A tool called formulador exists but it's written in Common Lisp, And another tool called cl4py also exists that allows lisp and python interoperability but it requires some form of lisp to be installed, it will be a hassle to make people install lisp and formulador and the general public that uses sphinx probably doesn't use math much ↩ ↩²