Skip to content

Commit 63f313f

Browse files
alhassyalhassy
committed
Revamp for EmacsConf2020 (•̀ᴗ•́)و
The new system is not backward compatible!!
1 parent f7d90e4 commit 63f313f

6 files changed

+7681
-3730
lines changed

‎README.md

Lines changed: 2 additions & 268 deletions
Original file line numberDiff line numberDiff line change
@@ -63,263 +63,6 @@
6363
> The full article may be read as a [PDF](https://alhassy.github.io/org-special-block-extras/index.pdf) or as [HTML](https://alhassy.github.io/org-special-block-extras) —or visit the [repo](https://github.com/alhassy/org-special-block-extras).
6464
> Installation instructions are [below](#Summary).
6565
66-
![img](images/foo_block.png "Extensibility! *Plug and play support for new block types!*")
67-
68-
*First, a gallery of what's possible!*
69-
70-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
71-
72-
73-
<colgroup>
74-
<col class="org-left" />
75-
</colgroup>
76-
<tbody>
77-
<tr>
78-
<td class="org-left">**Write Org-markup once, generate for many backends ^\_^**</td>
79-
</tr>
80-
</tbody>
81-
</table>
82-
83-
![img](images/colours.jpg)
84-
85-
![img](images/colour_links.png)
86-
87-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
88-
89-
90-
<colgroup>
91-
<col class="org-left" />
92-
</colgroup>
93-
<tbody>
94-
<tr>
95-
<td class="org-left">**Displaying thoughts side-by-side ^\_^**</td>
96-
</tr>
97-
</tbody>
98-
</table>
99-
100-
![img](images/parallel.png)
101-
102-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
103-
104-
105-
<colgroup>
106-
<col class="org-left" />
107-
</colgroup>
108-
<tbody>
109-
<tr>
110-
<td class="org-left">**“First-class editor comments” In order: Chrome, Emacs Web Wowser, Org source, PDF**</td>
111-
</tr>
112-
</tbody>
113-
</table>
114-
115-
![img](images/edcomm.png)
116-
117-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
118-
119-
120-
<colgroup>
121-
<col class="org-left" />
122-
</colgroup>
123-
<tbody>
124-
<tr>
125-
<td class="org-left">**Visually hiding, folding away, details**</td>
126-
</tr>
127-
</tbody>
128-
</table>
129-
130-
![img](images/details.png)
131-
132-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
133-
134-
135-
<colgroup>
136-
<col class="org-left" />
137-
</colgroup>
138-
<tbody>
139-
<tr>
140-
<td class="org-left">**An Emacs interface to <https://shields.io/>**</td>
141-
</tr>
142-
</tbody>
143-
</table>
144-
145-
![img](images/badges.png)
146-
147-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
148-
149-
150-
<colgroup>
151-
<col class="org-left" />
152-
</colgroup>
153-
<tbody>
154-
<tr>
155-
<td class="org-left">**Tooltips for documentation and glossary items &#x2013;in the browser!**</td>
156-
</tr>
157-
</tbody>
158-
</table>
159-
160-
![img](images/tooltips_browser.png)
161-
162-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
163-
164-
165-
<colgroup>
166-
<col class="org-left" />
167-
</colgroup>
168-
<tbody>
169-
<tr>
170-
<td class="org-left">**Tooltips for documentation and glossary items &#x2013;in Emacs!**</td>
171-
</tr>
172-
</tbody>
173-
</table>
174-
175-
![img](images/tooltips_emacs.png)
176-
177-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
178-
179-
180-
<colgroup>
181-
<col class="org-left" />
182-
</colgroup>
183-
<tbody>
184-
<tr>
185-
<td class="org-left">**Tooltips for documentation and glossary items &#x2013;in the PDF!**</td>
186-
</tr>
187-
</tbody>
188-
</table>
189-
190-
![img](images/tooltips_pdf.png)
191-
192-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
193-
194-
195-
<colgroup>
196-
<col class="org-left" />
197-
</colgroup>
198-
<tbody>
199-
<tr>
200-
<td class="org-left">**Declaring documentation-glossary items**</td>
201-
</tr>
202-
</tbody>
203-
</table>
204-
205-
![img](images/tooltips_declaration.png)
206-
207-
> The full article may be read as a [PDF](https://alhassy.github.io/org-special-block-extras/index.pdf) or as [HTML](https://alhassy.github.io/org-special-block-extras) &#x2014;or visit the [repo](https://github.com/alhassy/org-special-block-extras).
208-
> Installation instructions are [below](#Summary).
209-
210-
211-
# <a href="javascript:window.scrollTo(0,0)" style="color: black !important; border-bottom: none !important;" class="tooltip" title="Go to the top of the page"> Ξ </a>
212-
213-
1. [Summary](#Summary)
214-
1. [Installation Instructions](#Installation-Instructions)
215-
2. [Minimal working example](#Minimal-working-example)
216-
3. [Bye!](#Bye)
217-
218-
219-
<a id="Summary"></a>
220-
221-
# Summary
222-
223-
> The full article may be read as a [PDF](https://alhassy.github.io/org-special-block-extras/index.pdf) or as [HTML](https://alhassy.github.io/org-special-block-extras) &#x2014;or visit the [repo](https://github.com/alhassy/org-special-block-extras).
224-
225-
226-
Let `𝒞` be any of the following: `black`, `blue`, `brown`, `cyan`, `darkgray`, `gray`, `green`,
227-
`lightgray`, `lime`, `magenta`, `olive orange`, `pink`, `purple`, `red`, `teal`, `violet`, `white`,
228-
`yellow`. Let `𝓃` be any number from `1..5`.
229-
230-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
231-
232-
233-
<colgroup>
234-
<col class="org-left" />
235-
236-
<col class="org-left" />
237-
238-
<col class="org-left" />
239-
240-
<col class="org-left" />
241-
</colgroup>
242-
<thead>
243-
<tr>
244-
<th scope="col" class="org-left">Idea</th>
245-
<th scope="col" class="org-left">Block</th>
246-
<th scope="col" class="org-left">Link</th>
247-
<th scope="col" class="org-left">Switches</th>
248-
</tr>
249-
</thead>
250-
251-
<tbody>
252-
<tr>
253-
<td class="org-left">Colours</td>
254-
<td class="org-left">`𝒞`, `latex-definitions`</td>
255-
<td class="org-left">`𝒞`, `color:𝒞`</td>
256-
<td class="org-left">`:color:`</td>
257-
</tr>
258-
259-
260-
<tr>
261-
<td class="org-left">Parallel</td>
262-
<td class="org-left">`𝓃parallel[NB]`</td>
263-
<td class="org-left">-</td>
264-
<td class="org-left">`:columnbreak:`</td>
265-
</tr>
266-
267-
268-
<tr>
269-
<td class="org-left">Editorial Comments</td>
270-
<td class="org-left">`edcomm`</td>
271-
<td class="org-left">`edcomm`</td>
272-
<td class="org-left">`:ed:`, `:replacewith:`</td>
273-
</tr>
274-
275-
276-
<tr>
277-
<td class="org-left">Folded Details</td>
278-
<td class="org-left">`details`</td>
279-
<td class="org-left">-</td>
280-
<td class="org-left">`:title:`</td>
281-
</tr>
282-
283-
284-
<tr>
285-
<td class="org-left">Keystrokes</td>
286-
<td class="org-left">&#xa0;</td>
287-
<td class="org-left">`kbd`</td>
288-
<td class="org-left">&#xa0;</td>
289-
</tr>
290-
291-
292-
<tr>
293-
<td class="org-left">OctoIcons & Link Here</td>
294-
<td class="org-left">-</td>
295-
<td class="org-left">`octoicon, link-here`</td>
296-
<td class="org-left">-</td>
297-
</tr>
298-
299-
300-
<tr>
301-
<td class="org-left">Badges</td>
302-
<td class="org-left">-</td>
303-
<td class="org-left">`badge`</td>
304-
<td class="org-left">-</td>
305-
</tr>
306-
307-
308-
<tr>
309-
<td class="org-left">Documentation-Glossary</td>
310-
<td class="org-left">`documentation`</td>
311-
<td class="org-left">`doc`, `show`</td>
312-
<td class="org-left">`:name:`, `:label:`</td>
313-
</tr>
314-
</tbody>
315-
</table>
316-
317-
There are also the social badge links:
318-
`reddit-subscribe-to`, `github-followers`, `github-forks`, `github-stars,
319-
github-watchers`, `twitter-follow`, and `tweet`.
320-
321-
<span style="color:orange;">Going forward,</span> it'd be nice to a centralised ‘user manual’ which may be
322-
consulted rather than reading the literate implementation above.
32366

32467

32568
## Installation Instructions
@@ -366,7 +109,7 @@ The following example showcases the prominent features of this library.
366109
link-here:solution
367110
Syntactically, ~(apply f '(x0 ... xN)) = (f x0 ... xN)~.
368111

369-
[[edcomm:Musa][Ain't that cool?]]
112+
[[remark:Musa][Ain't that cool?]]
370113

371114
[[color:purple][We can apply a function to a list of arguments!]]
372115
#+end_details
@@ -379,15 +122,6 @@ The following example showcases the prominent features of this library.
379122

380123
show:GLOSSARY
381124

382-
badge:thanks|for_reading
383-
384-
tweet:https://github.com/alhassy/org-special-block-extras
385-
386-
badge:|buy_me_a coffee|gray|https://www.buymeacoffee.com/alhassy|buy-me-a-coffee
387-
125+
Way better instructions and images may be found at the HTML site.
388126

389127
## Bye!
390-
391-
[![badge:thanks](https://img.shields.io/badge/thanks-for_reading-nil)](nil)
392-
[![badge:https://github.com/alhassy/org-special-block-extras](https://img.shields.io/twitter/url?url=https://github.com/alhassy/org-special-block-extras)](https://twitter.com/intent/tweet?text=This%20looks%20super%20neat%20%28%E2%80%A2%CC%80%E1%B4%97%E2%80%A2%CC%81%29%D9%88%3A:&url=https://github.com/alhassy/org-special-block-extras)
393-
[![badge:](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/alhassy)

0 commit comments

Comments
 (0)