Writing
Hydejack offers a few additional features to markup your content.
Don’t worry, these are merely CSS classes added with kramdown’s {:...}
syntax,
so that your content remains compatible with other Jekyll themes.
Table of Contents
- A word on building speeds
- Adding a table of contents
- Adding message boxes
- Adding large text
- Adding large images
- Adding image captions
- Adding large quotes
- Adding faded text
- Adding tables
- Adding code blocks
- Adding math
A word on building speeds
If building speeds are a problem, try using the --incremental
flag, e.g.
bundle exec jekyll serve --incremental
From the Jekyll docs (emphasis mine):
Enable the experimental incremental build feature. Incremental build only re-builds posts and pages that have changed, resulting in significant performance improvements for large sites, but may also break site generation in certain cases.
The breakage occurs when you create new files or change filenames. Also, changing the title, category, tags, etc. of a page or post will not be reflected in pages other then the page or post itself. This makes it ideal for writing new posts and previewing changes, but not setting up new content.
Adding a table of contents
You can add a generated table of contents to any page by adding {:toc}
below a list.
Example: see above
Markdown:
* this unordered seed list will be replaced by toc as unordered list
{:toc}
Adding message boxes
You can add a message box by adding the message
class to a paragraph.
Example:
Markdown:
**NOTE**: You can add a message box.
{:.message}
Adding large text
You can add large text by adding the lead
class to the paragraph.
Example:
You can add large text.
Markdown:
You can add large text.
{:.lead}
Adding large images
You can make an image span the full width by adding the lead
class.
Example:
Markdown:
![Full-width image](https://placehold.it/800x100){:.lead data-width="800" data-height="100"}
Adding image captions
You can add captions to images by adding the figure
class to the paragraph containing the image and a caption.
Markdown:
![Full-width image](https://placehold.it/800x100){:.lead data-width="800" data-height="100"}
A caption for an image.
{:.figure}
For better semantics, you can also use the figure
/figcaption
HTML5 tags:
<figure>
<img alt="An image with a caption" src="https://placehold.it/800x100" class="lead" data-width="800" data-height="100" />
<figcaption>A caption to an image.</figcaption>
</figure>
Adding large quotes
You can make a quote “pop out” by adding the lead
class.
Example:
You can make a quote “pop out”.
Markdown:
> You can make a quote "pop out".
{:.lead}
Adding faded text
You can gray out text by adding the faded
class. Use this sparingly and for information that is not essential, as it is more difficult to read.
Example:
I’m faded, faded, faded.
Markdown:
I'm faded, faded, faded.
{:.faded}
Adding tables
Adding tables is straightforward and works just as described in the kramdown docs, e.g.
Default aligned | Left aligned | Center aligned | Right aligned |
---|---|---|---|
First body part | Second cell | Third cell | fourth cell |
Markdown:
| Default aligned |Left aligned| Center aligned | Right aligned |
|-----------------|:-----------|:---------------:|---------------:|
| First body part |Second cell | Third cell | fourth cell |
However, it gets tricker when adding large tables. In this case, Hydejack will break the layout and grant the table the entire available screen width to the right:
Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell |
Second line | foo | strong | baz | Second line | foo | strong | baz | Second line | foo | strong | baz | Second line | foo | strong | baz |
Third line | quux | baz | bar | Third line | quux | baz | bar | Third line | quux | baz | bar | Third line | quux | baz | bar |
Second body | Second body | Second body | Second body | ||||||||||||
2 line | 2 line | 2 line | 2 line | ||||||||||||
Footer row | Footer row | Footer row | Footer row |
Scroll table
If the extra space still isn’t enough, the table will receive a scrollbar.
It is browser default behavior to break the lines inside table cells to fit the content on the screen.
By adding the scroll-table
class on a table, the behavior is changed to never break lines inside cells, e.g:
Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell |
Second line | foo | strong | baz | Second line | foo | strong | baz | Second line | foo | strong | baz | Second line | foo | strong | baz |
Third line | quux | baz | bar | Third line | quux | baz | bar | Third line | quux | baz | bar | Third line | quux | baz | bar |
Second body | Second body | Second body | Second body | ||||||||||||
2 line | 2 line | 2 line | 2 line | ||||||||||||
Footer row | Footer row | Footer row | Footer row |
You can add the scroll-table
class to a markdown table by putting {:.scroll-table}
in line directly below the table.
To add the class to a HTML table, add the it to the class
attribute of the table
tag, e.g. <table class="scroll-table">
.
Flip table
Alternatively, you can “flip” (transpose) the table. Unlike the other approach, this will keep the table head (now the first column) fixed in place.
You can enable this behavior by adding flip-table
or flip-table-small
to the CSS classes of the table.
The -small
version will only enable scrolling on “small” screens (< 1080px wide).
Example:
Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned | Default aligned | Left aligned | Center aligned | Right aligned |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell | First body part | Second cell | Third cell | fourth cell |
Second line | foo | strong | baz | Second line | foo | strong | baz | Second line | foo | strong | baz | Second line | foo | strong | baz |
Third line | quux | baz | bar | Third line | quux | baz | bar | Third line | quux | baz | bar | Third line | quux | baz | bar |
4th line | quux | baz | bar | 4th line | quux | baz | bar | 4th line | quux | baz | bar | 4th line | quux | baz | bar |
5th line | quux | baz | bar | 5th line | quux | baz | bar | 5th line | quux | baz | bar | 5th line | quux | baz | bar |
6th line | quux | baz | bar | 6th line | quux | baz | bar | 6th line | quux | baz | bar | 6th line | quux | baz | bar |
7th line | quux | baz | bar | 7th line | quux | baz | bar | 7th line | quux | baz | bar | 7th line | quux | baz | bar |
8th line | quux | baz | bar | 8th line | quux | baz | bar | 8th line | quux | baz | bar | 8th line | quux | baz | bar |
9th line | quux | baz | bar | 9th line | quux | baz | bar | 9th line | quux | baz | bar | 9th line | quux | baz | bar |
10th line | quux | baz | bar | 10th line | quux | baz | bar | 10th line | quux | baz | bar | 10th line | quux | baz | bar |
You can add the flip-table
class to a markdown table by putting {:.flip-table}
in line directly below the table.
To add the class to a HTML table, add the it to the class
attribute of the table
tag, e.g. <table class="flip-table">
.
Small tables
If a table is small enough to fit the screen even on small screens, you can add the stretch-table
class
to force a table to use the entire available content width. Note that stretched tables can no longer be scrolled.
Default aligned | Left aligned | Center aligned | Right aligned |
---|---|---|---|
First body part | Second cell | Third cell | fourth cell |
You can add the stretch-table
class to a markdown table by putting {:.stretch-table}
in line directly below the table.
To add the class to a HTML table, add the it to the class
attribute of the table
tag, e.g. <table class="stretch-table">
.
Adding code blocks
To add a code block without syntax highlighting, simply indent 4 spaces (regular markdown).
For code blocks with code highlighting, use ~~~<language>
. This syntax is also supported by GitHub.
For more information and a list of supported languages, see Rouge.
Example:
// Example can be run directly in your JavaScript console
// Create a function that takes two arguments and returns the sum of those
// arguments
var adder = new Function("a", "b", "return a + b");
// Call the function
adder(2, 6);
// > 8
Markdown:
~~~js
// Example can be run directly in your JavaScript console
// Create a function that takes two arguments and returns the sum of those
// arguments
var adder = new Function("a", "b", "return a + b");
// Call the function
adder(2, 6);
// > 8
~~~
Adding math
Hydejack supports math blocks via KaTeX.
Why KaTeX instead of MathJax? KaTeX is faster and more lightweight at the cost of having less features, but for the purpose of writing blog posts, this should be a favorable tradeoff.
Before you add math content, make sure you have the following in your config file:
kramdown:
math_engine: mathjax # this is not a typo
math_engine_opts:
preview: true
preview_as_code: true
Inline
Example:
Lorem ipsum f(x) = x^2
.
Markdown:
Lorem ipsum $$ f(x) = x^2 $$.
Block
Example:
\begin{aligned}
\phi(x,y) &= \phi \left(\sum_{i=1}^n x_ie_i, \sum_{j=1}^n y_je_j \right) \\[2em]
&= \sum_{i=1}^n \sum_{j=1}^n x_i y_j \phi(e_i, e_j) \\[2em]
&= (x_1, \ldots, x_n)
\left(\begin{array}{ccc}
\phi(e_1, e_1) & \cdots & \phi(e_1, e_n) \\
\vdots & \ddots & \vdots \\
\phi(e_n, e_1) & \cdots & \phi(e_n, e_n)
\end{array}\right)
\left(\begin{array}{c}
y_1 \\
\vdots \\
y_n
\end{array}\right)
\end{aligned}
Markdown:
$$
\begin{aligned}
\phi(x,y) &= \phi \left(\sum_{i=1}^n x_ie_i, \sum_{j=1}^n y_je_j \right) \\[2em]
&= \sum_{i=1}^n \sum_{j=1}^n x_i y_j \phi(e_i, e_j) \\[2em]
&= (x_1, \ldots, x_n)
\left(\begin{array}{ccc}
\phi(e_1, e_1) & \cdots & \phi(e_1, e_n) \\
\vdots & \ddots & \vdots \\
\phi(e_n, e_1) & \cdots & \phi(e_n, e_n)
\end{array}\right)
\left(\begin{array}{c}
y_1 \\
\vdots \\
y_n
\end{array}\right)
\end{aligned}
$$
Continue with Scripts