https://github.com/parmsam/quarto-brainmade
Brainmade extension for HTML in Quarto
https://github.com/parmsam/quarto-brainmade
Last synced: about 1 month ago
JSON representation
Brainmade extension for HTML in Quarto
- Host: GitHub
- URL: https://github.com/parmsam/quarto-brainmade
- Owner: parmsam
- License: mit
- Created: 2025-01-02T16:34:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-10T17:08:19.000Z (over 1 year ago)
- Last Synced: 2025-01-10T18:25:10.931Z (over 1 year ago)
- Language: Lua
- Homepage: https://parmsam.github.io/quarto-brainmade/
- Size: 378 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Brainmade Extension For Quarto
The Brainmade mark is a symbol you can use to indicate that your work is primarily created by you or your friends, rather than generated by tools like ChatGPT. Designed by [Tristram Oaten](https://github.com/0atman), also known as [No Boilerplate](https://www.youtube.com/c/NoBoilerplate), the mark promotes authorship transparency. You can find the [original repository](https://github.com/0atman/Brainmade-org) for Brainmade on GitHub. The mark doesn’t require a work to be entirely human-made; it can use AI assistance as long as the majority of the work is human-made. This Quarto extension simplifies the process of adding the Brainmade mark into your HTML documents.
## Installing
```bash
quarto add parmsam/quarto-brainmade
```
This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.
## Using
After installing the extension for your Quarto project, you can use it in your Quarto documents. To use the extension, add the following [shortcode](https://quarto.org/docs/authoring/shortcodes.html) to your Quarto document for the brainmade dark mark:
```
{{< brainmade-dark >}}
```
Or the following shortcode for the brainmade light mark:
```
{{< brainmade-light >}}
```
The width or height of the mark can be adjusted by passing a width or height parameter:
```
{{< brainmade-dark width="52px">}}
{{< brainmade-dark height="52px">}}
```
You can also add small button versions of the marks:
```
{{< brainmade-dark-btn >}}
{{< brainmade-light-btn >}}
```
## Example
Here is the source code for a minimal example: [example.qmd](example.qmd).