X-Git-Url: https://git.ladys.computer/Beorn/blobdiff_plain/87e79e5a942a55f386f349242b8b554d6a50db4d..3a19eb936ebc72b3fb1d8757eefcc59bbb194b01:/README.markdown diff --git a/README.markdown b/README.markdown index 6cce62f..a0f3043 100644 --- a/README.markdown +++ b/README.markdown @@ -58,6 +58,9 @@ probably look something like this :— </awol:Feed> ``` +The value of `rdf:about` on the root element needs to be the absolute +U·R·L for your blog. + Your `entry.rdf` will look similar, but it needs a `sioc:content` property :— @@ -78,6 +81,9 @@ I love it! </awol:Entry> ``` +In this case, the `rdf:about` can be automatically filled in based on +the path to the entry from the blog root. + As you can see from the above example, 🧸📔 Bjørn supports a (nonstandard) `Markdown` value for `rdf:parseType` in addition to `Literal`. Some words of caution regarding this :— @@ -96,6 +102,27 @@ Alongside the metadata files, there are two template files, content will replace the first `<bjørn-content>` element. Metadata will be inserted into the `<head>` for you automatically. +## Serving Content + +You will need a file server which supports index files with a `.xhtml` +file extension. A sample `.rsync-filter` might be as follows :— + +```rsync-filter +- /.rsync-filter +-s .git +-s .gitignore +-s /README* +-s /build.js +-s /deno.json +-s index#*.xhtml +-s #*.rdf +``` + +## Customization + +Feel free to add styles, additional content, and whatever else you like +to the template files (as well as the rest of the website). + To modify what content is generated, simply edit `build.js` :) . [CommonMark]: <https://commonmark.org>