| title | Your Article Title Here | |
|---|---|---|
| date | 2026-01-01 | |
| description | A short, one- or two-sentence summary of the article. | |
| authors |
|
|
| categories |
|
|
| related_posts |
Open with a paragraph that says what the reader will get. No "= Title" heading here — the title above is already the page’s H1.
Sections start at ==. Sub-sections use ===. They become the "On this page"
navigation automatically.
Inline markup: bold, italic, monospace, and a
link with its text in brackets. Links to other sites
automatically open in a new tab; links to other foojay pages stay in the same
tab. (Adding AsciiDoc’s own ^ suffix — text — still
works and is left as you wrote it, but you no longer need it.)
-
A bullet
-
Another one
-
Nested, with two stars
-
A numbered item
-
The next one
-
-
A source block is a [source,<language>] line followed by a ---- fence. It is
syntax-highlighted by the same highlighter Markdown articles use, so the
language names are the same ones — java, bash, yaml, xml, kotlin,
json, python, sql and so on. An unknown one renders unhighlighted rather
than broken.
public class Hello {
public static void main(String[] args) {
System.out.println("Hello, foojay!");
}
}A ---- fence with no [source] line gives plain, unhighlighted output.
Any block takes a caption: a line starting with a dot, directly above it.
./gradlew buildNumbered markers in the code, explained underneath. Markdown has no equivalent.
Write the marker inside a comment for the language of the snippet — // for
Java, # for a shell or Python, -- for SQL — and the comment goes away in
the rendered article, leaving a circled number in its place. Line the markers
up in a column if you like; the padding in front of the comment is kept.
var list = new ArrayList<String>(); // (1)
list.add("foojay"); // (2)-
Create the list.
-
Add to it.
The labelled boxes that set a remark apart from the text around it. One word, then a colon:
|
Note
|
Something worth knowing. |
|
Tip
|
A shortcut the reader may not know. |
|
Important
|
Something they should not skip. |
|
Warning
|
Something that will bite them. |
|
Caution
|
Something that could lose data. |
cols sets the relative column widths; options="header" makes the first row
a header. A 2+| prefix spans two columns and .2+| spans two rows.
| Column | What goes in it |
|---|---|
First |
Something short |
Second |
Something longer, which is why this column is twice as wide |
Put the file in THIS folder and reference it by name. The text in the brackets is the DESCRIPTION, and it is the only part of an image a reader using a screen reader gets — write what it shows, the way you would say it out loud. Leave it empty only when the image is decoration; the PR check reports empty ones so you can confirm that was deliberate, and never fails your pull request over it.
Every image in an article is click-to-enlarge automatically.
Foojay’s own shortcodes work here too, for a floated or captioned image and for a gallery — see template/post.md for what each one takes:
{{< img src="my-image.png" alt="The Ports view in IntelliJ" class="alignright" width="320" caption="An optional caption" >}}
