byjp.me
A tool for archiving & converting scans of postcards, and information about them.
1# HTML
2
3Used in conjunction with the [css](css.md) and [web](web.md) formats, this output format creates a sample `{name}.html` file with an HTML fragment that's suitable to display the postcard being converted.
4
5> [!TIP]
6> The HTML fragment produced has two sections separated by `\n\n` (the only `\n\n` in the file). The first of these sections can be discarded if you're injecting the HTML into an already established postcards page.
7
8> [!NOTE]
9> In the unlikely even that the CSS being produced by the [css](css.md) format changes in a backwards incompatible way (which will only happen after a breaking change release of this tool) then any HTML previously produced by this format may also need to be updated. Details on how to manually make the needed changes will be in the release notes for this tool.
10
11## Example
12
13The following three output formats will create an HTML file that makes use of the CSS & web files to show the postcard in a visually appealing way.
14
15```sh
16$ postcards -f html,css,web pyramids-front.jpg
17⚙︎ Converting 1 postcard into 3 different formats…
18pyramids-front.jpg (Component files) → (HTML) pyramids.html
19pyramids-front.jpg (Component files) → (CSS) postcards.css
20pyramids-front.jpg (Component files) → (Web) pyramids.postcard.jpg
21```