Merge branch 'dev'

This commit is contained in:
Toastie 2024-06-13 02:19:32 +12:00
commit b798bd0d43
Signed by: toastie_t0ast
GPG key ID: 27F3B6855AFD40A4
44 changed files with 336 additions and 9728 deletions

11
.editorconfig Normal file
View file

@ -0,0 +1,11 @@
root = true
[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
trim_trailing_whitespace = true
[*.md]
max_line_length = 120

28
.gitattributes vendored Normal file
View file

@ -0,0 +1,28 @@
# Everything is text by default, unless we say otherwise.
# Also set everything to lf as line ending, because that's just way better.
* text eol=lf
# Images are definitely not text.
*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.tif binary
*.tiff binary
*.ico binary
# SVGs should be handled as text, though.
*.svg text
# Do some GitHub stats trickery.
_vendor/* linguist-vendored=true
# Scripts
*.bash text eol=lf
*.fish text eol=lf
*.sh text eol=lf
*.zsh text eol=lf
# These are explicitly windows files and should use crlf
*.bat text eol=crlf
*.cmd text eol=crlf
*.ps1 text eol=crlf

22
.gitignore vendored
View file

@ -1,20 +1,8 @@
# Dependencies .hugo_build.lock
/node_modules
# Production _vendor/
/build public/
resources/
# Generated files
.docusaurus
.cache-loader
# Misc
.DS_Store .DS_Store
.env.local .vscode/
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*

View file

@ -1,128 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
devs@elliebot.net.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

73
LICENSE Normal file
View file

@ -0,0 +1,73 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
Copyright 2024 toastie_t0ast
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

View file

@ -1,10 +1,6 @@
# EllieBot Docs # EllieBot Docs
EllieBot Docs ©2018-2023 toastie_t0ast EllieBot Docs ©2018-2024 toastie_t0ast
## Badges
[![Netlify Status](https://api.netlify.com/api/v1/badges/59b2c52e-91cf-496f-b520-cf3915215be1/deploy-status)](https://app.netlify.com/sites/elliebotdocs/deploys)
## Contribution Guide ## Contribution Guide

5
archetypes/default.md Normal file
View file

@ -0,0 +1,5 @@
+++
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
date = {{ .Date }}
draft = true
+++

View file

@ -1,3 +0,0 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};

9
content/Ellie/_index.md Normal file
View file

@ -0,0 +1,9 @@
+++
archetype = "chapter"
title = "EllieBot"
weight = 1
+++
Under this category you can find guides on how to do some things with EllieBot.
{{%children containerstyle="div" style="h2" description="true" %}}

View file

@ -1,4 +1,8 @@
# Contributing +++
title = "Ellie contribution guidelines"
description = "Steps on contributing to the Ellie bot project"
weight = 4
+++
## Hey there! ## Hey there!
If you are on this page that means you either want to help us or you are just curious about our project our contribution steps for the Ellie bot project are below If you are on this page that means you either want to help us or you are just curious about our project our contribution steps for the Ellie bot project are below

View file

@ -1,8 +1,8 @@
--- +++
sidebar_position: 1 title = "Ellie Expressions"
--- description = "How to use Ellie's expressions system"
weight = 1
# Expressions +++
### Important ### Important

View file

@ -1,10 +1,11 @@
--- +++
sidebar_position: 3 title = "Ellie Permissions System"
--- description = "How to use Ellie's permissions system"
weight = 3
+++
# Permissions Overview
Have you ever felt confused or even overwhelmed when trying to set Nadeko's permissions? In this guide we will be explaining **how to use the permission commands correctly** and even **cover a few common questions**! Every command we discuss here can be found in the [Commands List]. Have you ever felt confused or even overwhelmed when trying to set Ellie's permissions? In this guide we will be explaining **how to use the permission commands correctly** and even **cover a few common questions**! Every command we discuss here can be found in the [Commands List].
## Why do we use the Permissions Commands? ## Why do we use the Permissions Commands?
@ -61,9 +62,9 @@ To allow users to only see the current song and have a DJ role for queuing follo
1. `'sm Music disable` 1. `'sm Music disable`
- Disables music commands for everybody - Disables music commands for everybody
2. `'sc .nowplaying enable` 2. `'sc 'nowplaying enable`
- Enables the "nowplaying" command for everyone - Enables the "nowplaying" command for everyone
3. `'sc .listqueue enable` 3. `'sc 'listqueue enable`
- Enables the "listqueue" command for everyone - Enables the "listqueue" command for everyone
4. `'rm Music enable DJ` 4. `'rm Music enable DJ`
- Enables all music commands only for the DJ role - Enables all music commands only for the DJ role
@ -93,4 +94,4 @@ Yes, there is a way, in one easy command!
1. `'resetperms` 1. `'resetperms`
- This resets the permission chain back to default - This resets the permission chain back to default
[Commands List]: https://commands.elliebot.net [Commands List]: https://commands.elliebot.net

View file

@ -1,8 +1,8 @@
--- +++
sidebar_position: 2 title = "Ellie Placeholders"
--- description = "How to use Ellie's placeholders system"
weight = 2
# Placeholders +++
Placeholders are used in Quotes, Expressions, Greet/Bye messages, playing statuses, and a few other places. Placeholders are used in Quotes, Expressions, Greet/Bye messages, playing statuses, and a few other places.
@ -12,8 +12,12 @@ Some features have their own specific placeholders which are noted in that featu
## Usual placeholders ## Usual placeholders
!!! Note {{% notice style="note" title="Important note concerning embeds:" %}}
If you're using placeholders in embeds, don't use %user.mention% and %bot.mention% in titles, footers and field names. They will not show properly. If you're using placeholders in embeds,
don't use %user.mention% and %bot.mention% in titles,
footers and field names.
They will not show properly.
{{% /notice %}}
### Bot placeholders ### Bot placeholders
@ -34,7 +38,7 @@ Some features have their own specific placeholders which are noted in that featu
- `%server.members%` - Member count - `%server.members%` - Member count
- `%server.boosters%` - Number of users boosting the server - `%server.boosters%` - Number of users boosting the server
- `%server.boost_level%` - Server Boost level - `%server.boost_level%` - Server Boost level
- `%server.time%` - Server time (requires `'timezone` to be set) - `%server.time%` - Server time (requires `.timezone` to be set)
### Channel placeholders ### Channel placeholders
@ -42,7 +46,7 @@ Some features have their own specific placeholders which are noted in that featu
- `%channel.name%` - Channel name - `%channel.name%` - Channel name
- `%channel.id%` - Channel ID - `%channel.id%` - Channel ID
- `%channel.created%` - Channel creation date - `%channel.created%` - Channel creation date
- `%channel.nsfw%` - Returns either `True` or `False`, depending on if the channel is designated as NSFW using discord - `%channel.nsfw%` - Returns either `True` or `False`, depending on if the channel is designated as age-restricted in discord
- `%channel.topic%` - Channel topic - `%channel.topic%` - Channel topic
### User placeholders ### User placeholders

43
content/_index.md Normal file
View file

@ -0,0 +1,43 @@
+++
archetype = "home"
title = "Welcome"
+++
This site hosts the guides for EllieBot
Refer to the table below for the links to our sites, Ellie's invite link and Discord server.
| Site Name | Link |
|--------------|:------------------:|
| Ellie Invite | [Invite link] |
| Ellie Commands | [Commands site link] |
| Ellie Site | [Site link] |
| Ellie Blog | [Blog link] |
| Ellie Discord | [Discord link] |
| Ellie's Code | [Code repo] |
| Ellie patchnotes | [Notes link] |
[Invite link]: https://discordapp.com/oauth2/authorize?client_id=608119997713350679&scope=bot&permissions=66186303/
[Commands site link]: https://commands.elliebot.net
[Site link]: https://elliebot.net
[Blog link]: https://blog.elliebot.net
[Discord link]: https://discord.gg/etQdZxSyEH
[Code repo]: https://toastielab.dev/EllieBotDevs/Ellie-bot
[Notes link]: https://notes.elliebot.net

View file

@ -0,0 +1,9 @@
+++
archetype = "chapter"
title = "SupportChild"
weight = 2
+++
Under this category you can find guides on how to do some things with SupportChild.
{{%children containerstyle="div" style="h2" description="true" %}}

View file

@ -1,8 +1,8 @@
--- +++
sidebar_position: 1 title = "SupportChild Commands"
--- description = "Here is the full command list for SupportChild"
weight = 1
# Commands +++
| Command | Description | | Command | Description |
|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| |--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|

View file

@ -1,15 +0,0 @@
:::note
This page is scheduled for an update
:::
## Giveaway Commands
1. /start [channel-name] [Time] [winners] [Prize]
2. /reroll [giveawayid]
3. /end [prize name]
## Examples
1. /start #giveaway 5m 1 Testing
2. /end Testing
3. /reroll Testing

View file

@ -1,8 +0,0 @@
{
"label": "Holana",
"position": 5,
"link": {
"type": "generated-index",
"description": "The documentation for Holana."
}
}

View file

@ -1,8 +0,0 @@
{
"label": "SupportChild",
"position": 4,
"link": {
"type": "generated-index",
"description": "The documentation for SupportChild."
}
}

View file

@ -1,19 +0,0 @@
---
sidebar_position: 1
slug: /
---
# Home
This site hosts users guides for EllieBot
:::info[The Elliebot project links]
If you want to invite Ellie you can use [this link](https://discordapp.com/oauth2/authorize?client_id=608119997713350679&scope=bot&permissions=66186303)
Her commands are located at https://commands.elliebot.net
You can find Ellie's site at https://elliebot.net
You can also find the blog for the porject at https://blog.elliebot.net
:::

View file

@ -1,8 +0,0 @@
{
"label": "Ellie v4",
"position": 2,
"link": {
"type": "generated-index",
"description": "The documentation for Elliebot v4."
}
}

View file

@ -1,8 +0,0 @@
{
"label": "Ellie v5",
"position": 3,
"link": {
"type": "generated-index",
"description": "The documentation for the upcoming v5 update."
}
}

View file

@ -1,7 +0,0 @@
---
sidebar_position: 1
---
# Under construction
## This section of the documentation is coming soon!

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

View file

@ -1,107 +0,0 @@
// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config
import {themes as prismThemes} from 'prism-react-renderer';
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Elliebot Docs',
tagline: 'The documentation site for Elliebot',
favicon: 'img/favicon.ico',
// Set the production url of your site here
url: 'https://docs.elliebot.net',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: '', // Usually your GitHub org/user name.
projectName: '', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
routeBasePath: '/',
sidebarPath: './sidebars.js',
},
blog: false,
theme: {
customCss: './src/css/custom.css',
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
navbar: {
title: 'Elliebot docs',
logo: {
alt: 'My Site Logo',
src: 'img/logo.png',
},
items: [
{
href: 'https://toastielab.dev/EllieBotDevs/EllieBot-docs',
label: 'Toastielab',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Community',
items: [
{
label: 'Discord',
href: 'https://discord.com/invite/SVQVzJq',
},
],
},
{
title: 'More',
items: [
{
label: 'Toastielab',
href: 'https://toastielab.dev/EllieBotDevs/EllieBot-docs',
},
{
label: 'Our blog',
href: 'https://blog.elliebot.net'
}
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} EllieBotDevs`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
}),
};
export default config;

5
go.mod Normal file
View file

@ -0,0 +1,5 @@
module toastielab.dev/EllieBotDevs/EllieBot-docs
go 1.22.2
require github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442 // indirect

2
go.sum Normal file
View file

@ -0,0 +1,2 @@
github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442 h1:1RtA0zdTRxvcsvcYMp4h4bGlJ3hCKN1AD8YCeb7FGik=
github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=

32
hugo.toml Normal file
View file

@ -0,0 +1,32 @@
baseURL = 'https://docs.elliebot.net/'
languageCode = 'en-us'
title = 'The documentation site for EllieBot'
[markup]
[markup.tableOfContents]
# Some relatively important headers, like cc triggers, are on level 4;
# we want to have those in our table of contents, so we need to set this to 4.
endLevel = 4
[markup.goldmark]
[markup.goldmark.renderer]
# Enable HTML tags in Markdown
unsafe = true
[module]
[[module.imports]]
path = 'github.com/McShelby/hugo-theme-relearn'
[outputs]
home = [ "html", "search", "searchpage" ]
[params]
themeVariant = [
{ identifier = "zen-auto", name = "Zen Light/Dark", auto = [ "zen-light", "zen-dark" ] },
{ identifier = "zen-light" },
{ identifier = "zen-dark" },
]
collapsibleMenu = true
disableRootBreadcrumb = true
disableInlineCopyToClipboard = true
editURL = 'https://toastielab.dev/EllieBotDevs/EllieBot-docs/src/branch/main/content/'

View file

@ -0,0 +1 @@
<link rel="stylesheet" href="{{ relURL "css/menu.css" }}">

View file

@ -0,0 +1,48 @@
<style>
a#R-logo {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
font-size: 1.875rem;
font-weight: 300;
margin-top: -.8125rem;
max-width: 60%;
text-transform: uppercase;
width: 14.125rem;
white-space: nowrap;
}
a#R-logo:hover {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
}
@media only all and (max-width: 59.999rem) {
a#R-logo {
font-size: 1.5625rem;
margin-top: -.1875rem;
}
}
@media all and (-ms-high-contrast:none) {
{
{
"/* IE11s understanding of positioning is weird at best */" | safeCSS
}
}
a#R-logo {
margin-top: -3.625rem;
}
}
img {
margin-right: 0.5rem;
margin-top: -0.25rem;
vertical-align: middle;
}
</style>
<a id="R-logo" href="{{ relURL "" }}">
<img src="{{ relURL "images/logo.png" }}" width=30px height=30px>EllieBot
</a>

View file

@ -0,0 +1,21 @@
<!-- make sure links are visible as such -->
<style>
p.menu-footer > a {
text-decoration: underline !important;
}
</style>
<p class="menu-footer">
© 2018 - 2023 EllieBotDevs
</p>
<p class="menu-footer">
Ellie code available on <a href="https://toastielab.dev/EllieBotDevs/Ellie-bot"
title="Toastielab"><i class="fa-brands fa-git-alt"></i>Toastielab</a>
</p>
<!-- required to adhere to MIT license terms -->
<p class="menu-footer">
Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a>
by <a href="https://gohugo.io/">Hugo</a>
</p>

View file

@ -1,44 +0,0 @@
{
"name": "elliebot-docs",
"version": "0.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "3.0.0",
"@docusaurus/preset-classic": "3.0.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.2.1",
"prism-react-renderer": "^2.1.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.0.0",
"@docusaurus/types": "3.0.0"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 3 chrome version",
"last 3 firefox version",
"last 5 safari version"
]
},
"engines": {
"node": ">=18.0"
}
}

File diff suppressed because it is too large Load diff

View file

@ -1,33 +0,0 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
// But you can create a sidebar manually
/*
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
*/
};
module.exports = sidebars;

View file

@ -1,11 +0,0 @@
.features {
display: flex;
align-items: center;
padding: 2rem 0;
width: 100%;
}
.featureSvg {
height: 200px;
width: 200px;
}

View file

@ -1,30 +0,0 @@
/**
* Any CSS included here will be global. The classic template
* bundles Infima by default. Infima is a CSS framework designed to
* work well for content-centric websites.
*/
/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #2e8555;
--ifm-color-primary-dark: #29784c;
--ifm-color-primary-darker: #277148;
--ifm-color-primary-darkest: #205d3b;
--ifm-color-primary-light: #33925d;
--ifm-color-primary-lighter: #359962;
--ifm-color-primary-lightest: #3cad6e;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}
/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: #21af90;
--ifm-color-primary-darker: #1fa588;
--ifm-color-primary-darkest: #1a8870;
--ifm-color-primary-light: #29d5b0;
--ifm-color-primary-lighter: #32d8b4;
--ifm-color-primary-lightest: #4fddbf;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

View file

@ -1,23 +0,0 @@
/**
* CSS files with the .module.css suffix will be treated as CSS modules
* and scoped locally.
*/
.heroBanner {
padding: 4rem 0;
text-align: center;
position: relative;
overflow: hidden;
}
@media screen and (max-width: 996px) {
.heroBanner {
padding: 2rem;
}
}
.buttons {
display: flex;
align-items: center;
justify-content: center;
}

View file

@ -1,7 +0,0 @@
---
title: Markdown page example
---
# Markdown page example
You don't need React to write simple standalone pages.

View file

6
static/css/menu.css Normal file
View file

@ -0,0 +1,6 @@
/* Increase the margin a little bit such that it doesn't look too crowded
* on the menu side bar.
*/
#R-topics {
margin-left: 0.5em;
}

BIN
static/images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 273 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 182 KiB