Skip to content
This repository was archived by the owner on Feb 16, 2024. It is now read-only.

Commit 25a1178

Browse files
committed
Update README
To reflect recent changes and future tags.
1 parent 374059b commit 25a1178

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,25 @@ A Discourse Plugin (built on top of [discourse-awesome-bbcodes]) that adds
66
custom BBCode tags for [Doom Emacs' Discourse](//discourse.doomemacs.org). These
77
tags are:
88

9-
- `[dump]...[/dump]` --- Useful for large text dumps that shouldn't be indexed
10-
by the search engine. Our github issue tracker had a serious issue with system
11-
information polluting the search results.
12-
- `[float=left]...[/float]` or `[float=right]...[/float]` --- used to float
13-
content to the left or right.
14-
- `[clear][/clear]` --- used to clear floated content.
15-
- `[kbd command=+ivy/switch-workspace-buffer alt="C-x C-b,SPC b B]SPC b b[/kbd]` --- used to display key sequences with a tooltip showing what command its bound to and what alternative key sequences exist.
16-
- `[notice=TYPE]...[/notice]` --- creates a notice modal with an emoji icon based on TYPE. Out of the box `warning`, `note`, `idea`, and `info` are supported.
17-
- `[tabs id=ID title=TITLE]...[/tabs]` --- Tabbed sections of content. Use `[tab=ID]...[/tab]` inside.
9+
- [X] `[dump]...[/dump]` --- Useful for large text dumps that shouldn't be
10+
indexed by the search engine. Our github issue tracker had a serious issue
11+
with system information polluting the search results.
12+
- [X] `[float=left]...[/float]` or `[float=right]...[/float]` --- used to float
13+
content to the left or right.
14+
- [X] `[clear][/clear]` --- used to clear floated content.
15+
- [X] `[kbd command=+ivy/switch-workspace-buffer alt="C-x C-b,SPC b B]SPC b
16+
b[/kbd]` --- syntax sugar for key sequences. Will later be improved to
17+
display commands and alternative key sequences on mouseover.
18+
- [X] `[notice]...[/notice]` --- creates a notice modal (a blockquote). Uses the
19+
first emoji in the first element as the notice's icon, and appends a
20+
`notice-EMOJINAME` class to the enclosing blockquote.
21+
- [X] `[tabs id=ID title=TITLE]...[/tabs]` --- Tabbed sections of content. Use
22+
`[tab=ID]...[/tab]` inside.
23+
- [ ] A syntax to indicate Emacs symbols (functions/variables) that are
24+
auto-linked to http://doc.endlessparentheses.com/ (?)
25+
- [ ] A syntax to indicate Doom modules that are auto-linked to its
26+
documentation.
27+
1828

1929
## Installation
2030

0 commit comments

Comments
 (0)