add contrib.md file

This commit is contained in:
Mohammed Qureshi (Nova Cat) 2025-06-01 21:36:57 -07:00
parent 5856280398
commit c21835ae6c
Signed by: swee
GPG key ID: 770F5AC9169A5E67
2 changed files with 87 additions and 0 deletions

86
CONTRIB.md Normal file
View file

@ -0,0 +1,86 @@
# Contributing rules and suggestions
## 1. File name [RULE]
Your file name must contain a name or username at first, like `yourname-my-first-post`, this is to keep the posts directory organized.
## 2. Author [RULE]
When making a post, set the `author` field to your name (can be either username or realname), and the first part of the page should contain
```md
By [Your Name](https://your.site)
```
Replacing `Your Name` with what you put in the `author` field, and `https://your.site` to your website (can be external like social media and gravatar)
Example:
```
layout: post
title: "My First Post!"
date: 2024-06-01 00:00:00 -0700
categories: foo_bar
excerpt: A summary of your post.
author: Your Name
usemathjax: false
```
## 3. Comments [Suggestion]
If you want comments on your post, you can make an empty post in the [SweeBlogs Comments portion of Discuss Swee](https://discuss.swee.codes/c/16)
After making a post, copy its post ID, for example if the URL is
```
https://discuss.swee.codes/t/using-cloudflare-r2-object-storage-with-nextcloud/104
```
then the ID us `104`.
Set the `comments` attribute to the Discourse ID you found.
Example:
```md
---
layout: post
title: "My First Post!"
date: 2024-06-01 00:00:00 -0700
categories: foo_bar
excerpt: A summary of your post.
author: Your Name
usemathjax: false
comments: 104
---
```
## 4. Social Media Attribution [Suggestion]
If you want to help support more social media platforms for attribution, you can contribute!
Here are the supported social medias that can be used:
* Mastodon & The Fediverse
### 4.1 Mastodon/Fediverse
Set the `fediverse` attribute to your Mastodon/Fediverse username, you may also have to configure Mastodon or other Fediverse-compatible software to trust blogs.swee.codes to attribute you (In mastodon, Settings -> Public Profile -> Verification -> Author Attribution -> Websites allowed to credit you)
> [!WARNING]
> To avoid breaking the markdown renderer, use double quotes.
Example:
```md
---
layout: post
title: "My First Post!"
date: 2024-06-01 00:00:00 -0700
categories: foo_bar
excerpt: A summary of your post.
author: Your Name
usemathjax: false
fediverse: "you@mastodon.example.com"
---
```

View file

@ -60,6 +60,7 @@ exclude:
- LICENSE
- README.md
- node_modules
- CONTRIB.md
# Plugins
plugins: