12 | ...
24 |......
25 |Rapido.css: semantic HTML for your writings.
32 |Rapido provides a default style for a set of semantic HTML elements that you can use to compose your essays. Just write with semantic HTML, without the need to remember any CSS class or JS command.
33 |The present document has been created using Rapido, you can easily get documents or blog posts with the same layout and style. See how to use Rapido in the next sections.
34 |<article class="rapido">
36 | <section>
37 | <h1>...</h1>
38 | <p>...<small>...</small></p>
39 | </section>
40 | </article>Assign the CSS class rapido to the <article> element and you are done.
Rapido is just that: copy the HTML snippets and fill the gaps.
44 |Rapido is open source, view it on Github.
47 |Motivation
50 |Having your own corner on the web where you can freely share thoughts or technical stuff is still cool, and the popularity of tools like Jekyll or Gatsby proves that. Rapido intervenes there, offering semantic HTML templates for a variety of typical author needs: like header, sections, side notes, references and so on.The importance of using semantic HTML is a common theme in web development, it is a good idea to use the relevant HTML element for the job. Semantic HTML improves the usability of the code and ensures maximum accessibility.
51 |Rapido has been crafted with the idea that using semantic HTML for your writings can be easy. For such a reason Rapido does not make use of CSS classes or Javascript hooks, the author can compose all the different parts of the document with semantic HTML elements, for example adding side notes in paragraphs with the <small> element.
Getting started
55 |Rapido provides style rules in the rapido.css stylesheet, you can see the latest version of the CSS file in Github. Use rapido.css linking to it within the <head> element in your document.
60 |<head>58 |<link href="https://unpkg.com/@nextbitlabs/rapido@^3/rapido.css" rel="stylesheet" type="text/css">59 |</head>
Link to rapido.css in unpkg. Rapido uses semantic versioning, the example fetches the major release 3.x.
The style rules defined in rapido.css are name-spaced under the CSS class rapido. Being Rapido thought for web essays, the place to use the CSS class is the <article> element, as showed in the next snippet.
71 |<main>67 |<article class="rapido"> 68 | ... 69 | </article>70 |</main>
Assign CSS class rapido to the <article> element.
73 | Rapido can be used in a web document created from scratch or within an existing document, the CSS class rapido makes Rapido not invasive with respect to existing CSS code.
Install with npm
77 |Alternatively, you may want to install Rapido using npm. This is especially useful when you want to add Rapido as a dependency of your application.
78 |
79 | npm install @nextbitlabs/rapido
80 |
81 | Get your hands dirty
82 |If you want to try Rapido then you need the skeleton of an HTML document. The next code snippet provides a minimal template, copy the snippet in a fresh HTML file.
83 |<!DOCTYPE html>
85 | <html>
86 | <head>
87 | <meta charset="utf-8">
88 | <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=yes">
89 | <link href="https://unpkg.com/@nextbitlabs/rapido@^3/rapido.css" rel="stylesheet" type="text/css">
90 | </head>
91 | <body>
92 | <main>
93 | <article class="rapido">
94 | ...
95 | </article>
96 | </main>
97 | </body>
98 | </html>Minimal skeleton of an HTML document.
101 |Note the presence of the stylesheet rapido.css within the <head> element, it defines the style rules and it is all you need to use Rapido.
The next sections describe how to replace the ellipsis with the content of interest, like paragraphs, figures, tables and so on.
105 |Sections
109 |The previous code snippet shows a gap within the <article> element, you can fill the gap with sections. Typically, sections have a heading and one or more paragraphs. Moreover, sections may also contain figures, tables and much more.
122 |<main> 112 | <article>113 |<section> 114 | <h1>...</h1> 115 | <p>...</p> 116 | <p>...</p> 117 | <h2>...</h2> 118 | <p>...</p> 119 | </section>120 |</article> 121 | </main>
Code snippet of a section.
124 |The example shows a section with a heading and two paragraphs, a lower level heading and another paragraph.
125 |The code snippet above shows an example of implicit sectioning, where both the <h1> and <h2> elements are in the same section. Authors are encouraged to explicitly wrap sections in elements of sectioning content, instead of relying on the implicit sections generated by having multiple headings in one <section> element.
145 |<main> 130 | <article>131 |<section> 132 | <h1>...</h1> 133 | ... 134 | <section> 135 | <h2>...</h2> 136 | ... 137 | <section> 138 | <h3>...</h3> 139 | ... 140 | </section> 141 | </section> 142 | </section>143 |</article> 144 | </main>
Explicit sectioning.
147 |Sections in HTML5 can be nested, use headings of the appropriate rank for the section's nesting level. Explicit sectioning allows for predictable document outlines and better user experience.
148 |Title and abstract
154 |The <header> element is used for the title and few introductory paragraphs of your document. Generally, it is placed as the first element within the <article> element.
171 |<main> 157 | <article>158 |<header> 159 | <h1>...</h1> 160 | <p>...</p> 161 | <p>...</p> 162 | <address> 163 | <img src="..."> 164 | ... 165 | <a href="...">...</a> 166 | </address> 167 | </header>168 |... 169 | </article> 170 | </main>
Code snippet for the document header.
173 |The element <address> can be used to indicate the contact information of the authors. The element <img> is useful for adding the author avatar.
The header may also contain full-width images, as described in section Images and videos.
177 |Side comments
181 |This section describes how to add a side comment. Side comments typically show parenthetical content considered part of the main flow, like qualifying remarks directly related to the section.Side comments are related to the paragraph, therefore they usually appear right or below the text of the paragraph.
182 |A side comment should be inserted within the paragraph of a section, it will appear at the right of the paragraph and vertically aligned with it, or just below the paragraph on smaller screens.
183 |192 |<section> 185 | <h1>...</h1> 186 | <p> 187 | ...188 |<small>...<img src="...">...</small>189 |... 190 | </p> 191 | </section>
Code snippet of a side comment.
194 |Side comments may also contain pictures, added by means of the <img> element.
Images and videos
201 |Images and videos are displayed using the <img> and <video> elements. If a caption is needed, wrap images and videos within the <figure> element and use the <figcaption> element for the caption, as shown in the code snippet below. The <figcaption> element can contain a heading and one or more paragraphs.
204 | Artwork based on Perlin noise, written in GLSL.
206 |221 |<section> 210 | <h1>...</h1> 211 | <p>...</p>212 |<figure> 213 | <img src="image.jpg"> 214 | <figcaption> 215 | <h1>...</h1> 216 | <p>...</p> 217 | </figcaption> 218 | </figure>219 |<p>...</p> 220 | </section>
Code snippet of an image, with a descriptive caption.
223 |The <figure> element may be avoided if there is no need for a caption, in such a case the <img> element is a child of the <section> element. The default width of images is 600px, equals to the default width of text paragraph and code snippets. Authors can use inline style declarations to customise the width, as described in section Customisations.
Videos
227 |Exactly the same HTML code snippet is used for displaying videos, with the obvious difference of using the <video> element in place of the <img> element, as shown below.
241 |<section> 230 | <h1>...</h1> 231 | <p>...</p>232 |<figure> 233 | <video controls muted src="video.mp4"></video> 234 | <figcaption> 235 | <h1>...</h1> 236 | <p>...</p> 237 | </figcaption> 238 | </figure>239 |<p>...</p> 240 | </section>
Code snippet of a video with a caption.
243 |As with images, videos have a default width of 600 pixels, customisable with inline declarations as described in section Customisations.
244 |Quotations
250 |This section shows how to add quotations from another source into your document. The <blockquote> element can be inserted in a section within other paragraphs and may contain one or more paragraphs as well.
252 |254 | HTML Living Standard 255 |Content inside a blockquote must be quoted from another source, whose address, if it has one, may be cited in the cite attribute.
253 |
265 |<section> 257 | <h1>...</h1> 258 | <p>...</p>259 |<blockquote cite="https://..."> 260 | <p>...</p> 261 | </blockquote> 262 | <cite>...</cite>263 |<p>...</p> 264 | </section>
Code snippet of a quotation from another source.
267 |If appropriate, use the cite attribute for adding a URL of the quotation source and the <cite> element for the text representation.
Highlights
274 |The repetition of some content from the same source is used for the purposes of enticing readers or highlighting key topics. You can repeat a passage or an entire paragraph using the <aside> element inside a section.
287 |<section> 280 | <h1>...</h1> 281 | <p>...</p>282 |<aside> 283 | <p>...</p> 284 | </aside>285 |<p>...</p> 286 | </section>
Code snippet of an highlight.
289 |Highlights are styled with a font bigger than the surrounding text.
290 |Tables
296 |As well as with images and videos, tables are displayed within the <figure> element, with an optional caption. Tables are useful for displaying tabular data with few or several columns, if the table is bigger than the window width the hidden part is visible through mouse scrolling.
298 |
327 |
329 |
330 |
299 |
300 |
301 |
325 |
326 | | Tag | 303 |Meaning | 304 |Description | 305 |
|---|---|---|
<em> |
310 | emphasis | 311 |Use it for adding emphasis to a word, compared to surrounding text. Example: "We had to do something about it." | 312 |
<strong> |
315 | importance | 316 |Use it to mark text that has greater importance than surrounding text. Example: "Warning! This is very dangerous." | 317 |
<mark> |
320 | relevance | 321 |Use it to denote content which has a degree of relevance, for example highlighting search results or code fragments. | 322 |
We take the opportunity of this example to describe the semantic meaning of elements <em>, <strong> and <mark>. Examples are taken from the MDN web docs.
358 |<section> 332 | <h1>...</h1> 333 | <p>...</p>334 |<figure> 335 | <div> 336 | <table> 337 | <thead> 338 | <tr> 339 | <th>...</th> 340 | <th>...</th> 341 | </tr> 342 | </thead> 343 | <tbody> 344 | <tr> 345 | <td>...</td> 346 | <td>...</td> 347 | </tr> 348 | <tr> 349 | <td>...</td> 350 | <td>...</td> 351 | </tr> 352 | </tbody> 353 | </table> 354 | </div> 355 | </figure>356 |<p>...</p> 357 | </section>
Code snippet of a table.
360 |The <thead> element defines the head of the table columns, instead, the <tbody> element is used for the table body. Note that, differently from images and videos, there is an extra <div> container wrapping the <table> element. The default width is 600px, authors can use inline style declarations to customise the table width, as described in section Customisations.
Lists
367 |Lists are created with the <ul> and <ol> elements, whereas <li> element is used to represent list items.
-
369 |
-
370 |
use the
371 |<ol>element for ordered lists
372 | -
373 |
use the
374 |<ul>element for unordered lists
375 |
390 |<section> 378 | <h1>...</h1> 379 | <p>...</p>380 |<ul> 381 | <li> 382 | <p>...</p> 383 | </li> 384 | <li> 385 | <p>...</p> 386 | </li> 387 | </ul>388 |<p>...</p> 389 | </section>
Code snippet of code list.
392 |Use the <ol> element when the order is meaningful, ordered list are rendered as a numbered list:
-
394 |
first item
395 | second item
396 |
Code
403 |Listings of code can be inserted inline inside a paragraph or within element <figure> for multiple lines of code.
<p>...<code>...</code>...</p>Code snippet of code listings.
408 |Add inline code using the <code> element.
415 |<figure>413 |<pre><code>...</code></pre>414 |</figure>
Wrap the <code> element within the <pre> element to add multiple lines of code.
As with images, videos and tables, the default width is 600px. You can use inline declarations to customise the width, for example setting 100% width with <pre style="width: 100%">. See section Customisations for more details.
Example 1
421 |const f = n => n ? n * f(n - 1) : 1;Factorial function in Javascript.
425 |The next code snippet shows how to write the factorial function above.
428 |<figure>
430 | <pre><code>const f = n => n ? n * f(n - 1) : 1;</code></pre>
431 | </figure>Listing 1
434 |Example 2
437 |This example shows how to obtain the expected indentation with more lines of code. As rule of thumb, paste the code directly within the <pre><code>...</code></pre> elements.
function factorial (n) {
440 | return n ? n * factorial(n - 1) : 1;
441 | }<figure>
445 | <pre><code>function factorial (n) {
446 | return n ? n * factorial(n - 1) : 1;
447 | }</code></pre>
448 | </figure>Example 3
451 |A special treatment is necessary for HTML code because it needs to be escaped: use string < for < and string > for >.
<figure>
454 | <pre><code><figure>
455 | <pre><code>const f = n => n ? n * f(n - 1) : 1;</code></pre>
456 | </figure></code></pre>
457 | </figure>Snippet used for the HTML code of listing 1.
460 |Highlight code
463 |You can highlight code in two different ways: inline or full lines.
464 |<figure>
466 | <pre><code>...<mark>...</mark>...</code></pre>
467 | </figure>Highlight a portion of a line.
470 |Wrap the relevant code within the <mark> element.
Instead, highlight one or more lines of code wrapping the full line within the <mark> element, the next snippet shows an example.
480 |<figure>476 |<pre><code>...</code>477 |<mark><code>...</code></mark>478 |<code>...</code></pre>479 |</figure>
Highlight full lines of code.
482 |Note that, within the <pre> element, indentation spaces and new lines deserve special attention in order to represent the right code formatting.
Math formulas
489 |Math typesetting is not supported by default. We suggest using KaTeX, a popular JavaScript library for TeX math rendering on the web. To get KaTex working, copy and paste the next code within the <head> element (see section Getting Started).
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.10.0-rc.1/dist/katex.min.css" integrity="sha384-D+9gmBxUQogRLqvARvNLmA9hS2x//eK1FhVb9PiU86gmcrBrJAQT8okdJ4LMp2uv" crossorigin="anonymous">
492 | <script defer src="https://cdn.jsdelivr.net/npm/katex@0.10.0-rc.1/dist/katex.min.js" integrity="sha384-483A6DwYfKeDa0Q52fJmxFXkcPCFfnXMoXblOkJ4JcA8zATN6Tm78UNL72AKk+0O" crossorigin="anonymous"></script>
493 | <script defer src="https://cdn.jsdelivr.net/npm/katex@0.10.0-rc.1/dist/contrib/auto-render.min.js" integrity="sha384-yACMu8JWxKzSp/C1YV86pzGiQ/l1YUfE8oPuahJQxzehAjEt2GiQuy/BIvl9KyeF" crossorigin="anonymous" onload="renderMathInElement(document.body,{delimiters: [{left: '$$', right: '$$', display: true},{left: '$', right: '$', display: false}]});"></script>Example 1
496 |You can insert mathematics inline on a paragraph, like the famous equivalence between energy and inertial mass $E = mc^2$, surrounding the mathematical formula with symbols $...$, as presented below.
<p>... $E = mc^2$ ...</p>Inline formula.
501 |Example 2
504 |Having your formula in a new line is easy as well, just use $$...$$ instead of $...$.
$$G_{\mu\nu} + \Lambda g_{\mu\nu} = \frac{8\pi G}{c^4}T_{\mu\nu}$$Einstein field equations [1], expressed for the first time 8 years later the the happiest thought of my life
[2].
<p>
508 | ...
509 | $$G_{\mu\nu} + \Lambda g_{\mu\nu} = \frac{8\pi G}{c^4}T_{\mu\nu}$$
510 | ...
511 | </p>Example 3
514 |KaTeX supports a wide list of TeX functions. For example, for the representation of the following system of equations, we make use of the \begin{array} environment.
517 | $$\begin{array}{rcl} 518 | \nabla \cdot \mathbf{E} & = & 0 \\\\ 519 | \nabla \cdot \mathbf{B} & = & 0 \\\\ 520 | \nabla \times \mathbf{E} & = & - \displaystyle\frac{1}{c} \displaystyle\frac{\partial \mathbf{B}}{\partial t} \\\\ 521 | \nabla \times \mathbf{B} & = & \displaystyle\frac{1}{c} \displaystyle\frac{\partial \mathbf{E}}{\partial t} 522 | \end{array}$$ 523 |
524 |Maxwell's equations in vacuum.
526 |The equations can be reduced to the standard wave equation $$ 527 | \frac{1}{c^2} \frac{\partial^2 \mathbf{F}}{\partial^2 t} - \nabla^2 \mathbf{F} = 0 528 | $$ providing the theoretical background for the electromagnetic waves [3].
529 |<figure>
533 | <p>
534 | $$\begin{array}{rcl}
535 | \nabla \cdot \mathbf{E} & = & 0 \\\\
536 | \nabla \cdot \mathbf{B} & = & 0 \\\\
537 | \nabla \times \mathbf{E} & = & - \displaystyle\frac{1}{c} \displaystyle\frac{\partial \mathbf{B}}{\partial t} \\\\
538 | \nabla \times \mathbf{B} & = & \displaystyle\frac{1}{c} \displaystyle\frac{\partial \mathbf{E}}{\partial t}
539 | \end{array}$$
540 | </p>
541 | </figure>Use TeX functions for more sophisticated math typesetting. Use the <figure> element if a caption is needed. The default width of the <p> element within the <figure> element is 600px. Authors can use inline style declarations to customise the width for larger formulas, as described in section Customisations.
Customisations
550 |Rapido focuses on semantic HTML, providing a default style for a variety of HTML elements. Being CSS classes out of scope, authors looking for a different style must opt for a customisation.Rapido does not expose CSS classes. This design choice makes Rapido easier to use and, due to how specificity works, easier to extend with custom CSS classes.
551 |You may change the default CSS rules or write new rules that have precedence over the default ones. As usual, this is possible both with inline declarations and stylesheets. The following examples show some common customisations. 552 |
553 |565 |<head> 555 | ...556 |<style> 557 | article.rapido { 558 | font-family: "Helvetica Neue"; 559 | } 560 | article.rapido code { 561 | font-family: "Iosevka"; 562 | } 563 | </style>564 |</head>
Font families.
567 |You can easily change the default font families, both for code and normal text.
568 |586 |<head> 572 | ...573 |<style> 574 | article.rapido code { 575 | color: rgba(0, 0, 255, 1); 576 | } 577 | article.rapido pre > mark > code { 578 | border-left: 2px solid rgba(0, 0, 255, 1); 579 | background: rgba(0, 0, 255, 0.05); 580 | } 581 | article.rapido mark { 582 | background: rgba(0, 0, 255, 0.1); 583 | } 584 | </style>585 |</head>
Font colour on code snippets.
588 |The default colour is blue, authors are encouraged to choose the colour that better adapts to the pre-existing style if any.
589 |<figure>
593 | <img src="..." style="width: 100%">
594 | ...
595 | </figure>Full-width images, videos, tables and code snippets.
598 |The default width is 600 pixels, you can assign to an image a bigger or smaller width than the default one. Full width equals to 944 pixels.
599 |610 |<head> 603 | ...604 |<style> 605 | .rapido .full-width { 606 | width: 100%; 607 | } 608 | </style>609 |</head>
Full-width images can be obtained also defining an apposite CSS class, which can be used with <img src="..." class="full-width">. On the same way it can be used with videos (<video>), code snippets (<pre>) and tables (<div>).