The page layout is a template that lives in the currently used theme. Open up “themes/propeller-1.0/templates/layout.html”. You should see some fairly basic HTML as well as some variables rendered by magnet. Note however, the “block content” section. This block is filled in by the “index.html” file, where the HTML for these posts lives. Changing the “layout.html” and “index.html” files lets you render the site very differently. For instance, in the site settings (“site.yaml”) change the value
theme-name: propeller-1.0
to
theme-name: simple-1.0
and restart magnet, you’ll see different templating and css applied.
Metadata at the top of each Markdown post can include Tags and or an Author.
---
title: "More About Rocks"
publish: 2023-04-01 10:00:00
tags: rocks
author: "Susan Essay"
summary: "More than you ever wanted to know about rocks..."
---
Also, Tags and or an Author can be included in the Post Settings file:
---
name: "Susan's Posts"
archive: true
blogroll: true
author: "Susan Essay"
tags: geology
Tags for each post are amended — so if the post meta has tags “things, stuff” and the post settings has “geology” then the published post will have the tags “things, stuff, geology”.
Author in only a single value, so it is not amended but is set.
Including Local Images ¶
Including images in a post is done in Markdown.
Take a look at the file “posts/images.md”, you’ll see that there are local images and remote images in the markdown. This one for instance:
Including Remote Images ¶
You can include images from remote sources by using the remote url in the markdown. The image will be pulled down and placed into your images directory, and it should only do this once.
Since we can’t rely on the original name being well-formed or unique, the remote image gets renamed when it is saved. JPG, PNG or GIF can be included this way.
Images Index ¶
An image index is created in the “indices” directory so that remote images are only pulled down once. If you need to re-pull images either edit or remove the “images.json” file in the “indices” directory.
You might want to use a custom URI for a posts:
---
title: "Using A Custom Post ID"
publish: 2023-12-16 12:13:13
id: thingstuff
tags: about-ids
summary: "Showing a custom ID..."
---
This will be served under:
http://127.0.0.1:8081/post/thingstuff/
where “thingstuff” is used instead of the filename of the post markdown. The filename of this post is “custom-id.md” (you can name posts whatever you want), so without the ID set in metadata the local url would look like:
http://127.0.0.1:8081/post/custom-id/
If there are more than one files named the same (across different post directories for instance) the ID will have a small random suffix added to prevent collision.
A good practice is to name files with two pieces of information, say, date and title. For instance:
20230330-custom-ids.md
Naming like this, consistently, means you’ll be able to easily glance over the file tree to see your posts and also likely avoid naming two files the same thing.
Basic HTML should render properly.
Here’s a table:
An H3, p tag:
Test
And this paragraph has a p tag with a css class.
Complex HTML alongside markdown may not render properly.