Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JustYuuto committed Nov 7, 2024
1 parent 2c04cc5 commit 82c330b
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 9 deletions.
11 changes: 11 additions & 0 deletions docs/account/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label": "Your Account",
"collapsed": false,
"collapsible": true,
"position": 2,
"link": {
"type": "generated-index",
"title": "Your Account",
"description": "Learn how to manage your account, from customizing your profile to managing your settings."
}
}
Binary file added docs/account/custom-domain-field.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/account/custom-domain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
sidebar_position: 3
---

# Custom Domain

:::note

This feature requires you to be a Premium user.

:::

Imagine you own the domain "example.com". Maybe you'd like your Miwa.lol profile to appear directly on that domain (so that when you go to "example.com", it shows your Miwa.lol profile).

This section explains how to set up a custom domain for your account. No worries—it's relatively simple.

## What You Need

To make this work, you’ll need:

* A domain name (obviously, this guide won't help much without one!)
* Full access to your domain’s DNS records

## Setting Up Your Custom Domain

1. First, go to your [account settings](https://miwa.lol/dashboard/settings) and click on the pencil icon in the "Custom Domain" field:

![](./custom-domain-field.png)

2. Next, create a DNS record of type **CNAME**. Set the **name** to your domain (e.g., "domain.tld" without "https://" or any additional path) and the **value** to `miwa.lol`.

3. Once that’s done, click the "Next" button.

4. We’ll then prompt you to create a **TXT record**. Set the **name** to `_cf-custom-hostname.domain.tld` (replacing "domain.tld" with your domain) and use the provided UUID as the **value**.

5. Finally, click "Verify domain.tld" in your settings.

Once completed, visit your domain. If everything is set up correctly, your Miwa.lol profile will display!
11 changes: 11 additions & 0 deletions docs/account/username.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 1
---

# Username

Your username is what lets others access your Miwa.lol profile at the URL https://miwa.lol/username (where "username" is replaced by your actual username).

Your username is unique: if someone else has already taken it, you’ll need to choose a different one.

It can only contain letters, numbers, and certain special characters (@, -, .).
9 changes: 0 additions & 9 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,6 @@ const config: Config = {
}
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Miwa.lol - Built with Docusaurus.`,
},
Expand Down

0 comments on commit 82c330b

Please sign in to comment.