Skip to content

Commit 6b8463d

Browse files
committed
Migrate to Docusaurus
I wasn't thrilled with mkdocs. It wasn't amazing to use, and didn't look all that professional.
1 parent 3031090 commit 6b8463d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+23733
-711
lines changed

.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

Pipfile

Lines changed: 0 additions & 12 deletions
This file was deleted.

Pipfile.lock

Lines changed: 0 additions & 511 deletions
This file was deleted.

babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

docs/figure.jsx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import React from 'react'
2+
import useBaseUrl from '@docusaurus/useBaseUrl'
3+
4+
export default function Figure({ src, caption }) {
5+
return (
6+
<figure style={{ 'margin': '30px 0' }}>
7+
<div style={{ 'display': 'flex', 'justify-content': 'center' }}>
8+
<img src={useBaseUrl(src)} alt={caption} style={{ 'display': 'auto', 'border-radius': '10px', 'max-width': '100%', 'width': '600px' }} />
9+
</div>
10+
<figcaption style={{ 'text-align': 'center', 'font-style': 'italic' }}>{caption}</figcaption>
11+
</figure>
12+
)
13+
}

docs/faq.md renamed to docs/guides/faq.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
# Frequently Answered Questions
1+
---
2+
title: FAQ
3+
sidebar_position: 2
4+
slug: /faq
5+
---
6+
7+
# Frequently answered questions
8+
9+
These are some of the questions we get most often.
10+
11+
If you're not able to resolve an issue, please get in touch on our [Discord server](https://discord.com/invite/dMnZt6P).
212

313
---
414

docs/guides/figure.jsx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import React from 'react'
2+
import useBaseUrl from '@docusaurus/useBaseUrl'
3+
4+
export default function Figure({ src, caption }) {
5+
return (
6+
<figure style={{ 'margin': '30px 0' }}>
7+
<div style={{ 'display': 'flex', 'justify-content': 'center' }}>
8+
<img src={useBaseUrl(src)} alt={caption} style={{ 'display': 'auto', 'border-radius': '10px', 'max-width': '100%', 'width': '600px' }} />
9+
</div>
10+
<figcaption style={{ 'text-align': 'center', 'font-style': 'italic' }}>{caption}</figcaption>
11+
</figure>
12+
)
13+
}
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
---
2+
sidebar_position: 1
3+
slug: /
4+
---
5+
16
# Getting started
27

38
Getting started with Apollo is quick and easy.
49

510
1. [Invite Apollo to your server](https://discord.com/api/oauth2/authorize?client_id=475744554910351370&permissions=36776045648&scope=applications.commands%20bot)
6-
2. Create your first event with the [`/event`](/creating-events/) command
11+
2. Create your first event with the [`/event`](/creating_events/) command
712
- Apollo will then DM you a list of questions about your event
813
- Once finished, Apollo will provide a link to your newly created event
914
3. RSVP to the event by clicking one of the event buttons

docs/guides/guides/_category_.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
label: Guides
2+
collapsed: false
Lines changed: 43 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
description: Manage which roles are assigned to attendees.
3+
slug: /attendee_roles
4+
sidebar_position: 6
5+
---
6+
17
# Attendee roles
28

39
[Apollo Premium](https://apollo.fyi/premium) allows event organizers to
@@ -12,9 +18,10 @@ Once an attendee role is setup, attendees will be given the role when they sign
1218
up for the event. The role will be removed from attendees when they remove their
1319
signup, or the event is deleted.
1420

15-
!!! warning "Permission check"
16-
Apollo must have the `Manage Roles` permission in order to assign roles to
17-
attendees.
21+
:::warning Permission check
22+
Apollo must have the `Manage Roles` permission in order to assign roles to
23+
attendees.
24+
:::
1825

1926
## Temporary attendee roles
2027
When using a temporary role, Apollo will create a role in the format of:
@@ -36,9 +43,10 @@ new events by default with `/settings temp_roles on`.
3643

3744
This command requires the `Manage Server` permission to invoke.
3845

39-
!!! note
40-
If temporary roles are enabled by default, they can still be configured on a
41-
per event basis.
46+
:::note
47+
If temporary roles are enabled by default, they can still be configured on a
48+
per event basis.
49+
:::
4250

4351
## Persistent attendee roles
4452

@@ -47,45 +55,50 @@ role to attendees as they update their responses.
4755

4856
When the event is deleted, the role will be removed from all attendees.
4957

50-
!!! note
51-
Apollo will not allow users to assign a persistent attendee role if they
52-
don't personally have permission to `Manage Roles` on the server.
58+
:::note
59+
Apollo will not allow users to assign a persistent attendee role if they
60+
don't personally have permission to `Manage Roles` on the server.
61+
:::
5362

54-
!!! warning
55-
When using a persistent attendee role, the role must be **below**
56-
Apollo's highest role in the role hierarchy list, otherwise Apollo will not
57-
be able to add the role to attendees.
63+
:::warning
64+
When using a persistent attendee role, the role must be **below**
65+
Apollo's highest role in the role hierarchy list, otherwise Apollo will not
66+
be able to add the role to attendees.
67+
:::
5868

5969
### Multiple events
6070

6171
When multiple events share the same persistent attendee role, the role is only
6272
removed from an attendee when they are not signed up for any events with the
6373
persistent attendee role.
6474

65-
!!! example
66-
John signs up for two events, both of which have the same persistent
67-
attendee role.
75+
:::tip Example
76+
John signs up for two events, both of which have the same persistent
77+
attendee role.
6878

69-
John's attendee role will be removed when his responses are removed from
70-
both events. Response removal can occur by John manually removing his
71-
signup, but it will also occur if the event is deleted.
79+
John's attendee role will be removed when his responses are removed from
80+
both events. Response removal can occur by John manually removing his
81+
signup, but it will also occur if the event is deleted.
82+
:::
7283

7384
## Using attendee roles
7485

75-
!!! info inline end
76-
Attendee roles are granted to users who sign up for signup options that have
77-
**reminders enabled**.
78-
79-
By default, only the **Accepted** option has reminders enabled, but this can
80-
be configured on a per event basis.
81-
8286
An attendee role can be configured during event creation on the advanced options
8387
prompt (the last prompt when creating an event).
8488

8589
When the attendee role option is selected, you’ll have the option to let Apollo
8690
create a temporary attendee role, or to specify an existing role to assign to
8791
attendees.
8892

93+
:::note
94+
Attendee roles are granted to users who sign up for signup options that have
95+
**reminders enabled**.
96+
97+
By default, only the **Accepted** option has reminders enabled, but this can
98+
be configured on a per event basis.
99+
:::
100+
101+
89102
## Modify attendee roles
90103

91104
Attendee roles can be fully modified for both single and recurring
@@ -94,6 +107,7 @@ events.
94107
When an event attendee role is added, removed, or updated, we’ll go through the
95108
list of attendees on the event to ensure that their attendee role is correct.
96109

97-
!!! note
98-
When updating an attendee role for an event with a large number of
99-
attendees, it can take a minute to update everyone’s role.
110+
:::note
111+
When updating an attendee role for an event with a large number of
112+
attendees, it can take a minute to update everyone’s role.
113+
:::

0 commit comments

Comments
 (0)