Update Home

Nathan Upchurch 2024-07-09 13:27:21 -04:00
parent d9ae632daf
commit f5567aed89

22
Home.md

@ -1,8 +1,12 @@
# Documentation
#Wiki Home
## About
### Planned Features
## Metadata
## Documentation
### Metadata
Features configured in `metadata.js`:
### /me
#### /me
Links at /me are configured in `metadata.js` like so:
``` javascript
socialLinks: [
@ -16,7 +20,7 @@ socialLinks: [
```
Any links added here will render on the /me page.
### Webrings
#### Webrings
Webrings configured in `metadata.js` will display in the footer of most pages beneath the copyright notice:
``` javascript
webrings: [
@ -29,10 +33,10 @@ webrings: [
]
```
## Mastodon Integration
### Mastodon Integration
Integrate Mastodon toots into blog posts.
### Embed a toot from Mastodon using the `toot` shortcode:
#### Embed a toot from Mastodon using the `toot` shortcode:
```
{% toot "instance", "tootID" %}
```
@ -42,13 +46,13 @@ For example:
```
Embedded toots are live, so if the toot or instance is not reachable, the toot will not be shown on the page. I haven't built any error handling for this yet.
### Adding comments via Mastodon
#### Adding comments via Mastodon
Simply add a toot ID to a post's frontmatter using the `mastodon_id` key in order to enable commenting via Mastodon:
## Other Special Features
### Other Special Features
Special or uncommon features of this blog that aren't configured in `metadata.js`.
### Add a cowsay to a post
#### Add a cowsay to a post
You can use the `cowsay` filter to output a captioned `<figure>` containing a copy of an output from the cowsay program. Instead of using the usual three backticks, this method is accessible to visually impaired users thanks to the automatic captioning. Here's how to do it:
1. Add a copy of the cowsay output you'd like to display to _data/cowList.js. Be sure and escape any backslashes.