Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 2
---

# FAQ

### A monster, spell, subclass, etc. is missing from the API / Database. Can I add it?
Expand All @@ -14,15 +18,6 @@ The SRD, or Systems Reference Document, contains guidelines for publishing conte

The Open Game License (OGL) is a public copyright license by Wizards of the Coast that may be used by tabletop role-playing game developers to grant permission to modify, copy, and redistribute some of the content designed for their games, notably game mechanics. However, they must share-alike copies and derivative works. [More information about the OGL can be found here.](https://en.wikipedia.org/wiki/Open_Game_License)

### Can I support this project? Where can I contribute to this project?

Yes! Please! This is a evolving API and having fresh ideas are always welcome! You can open an issue in either repo, open a PR for changes, or just discuss with other users in this discord.

Additionally, there is a separate Docker image for each repo so you only have to run as much as you need.

[The repo for the data lives here.](https://github.com/bagelbits/5e-database)
[The repo for the API lives here.](https://github.com/bagelbits/5e-srd-api)

### Can this API be self hosted?

Yes it can! You can also host the data yourself if you don't want to use the API at all. You can also make changes and add extra data if you like. However, it is up to you to merge in new changes to the data and API.
Expand Down
23 changes: 0 additions & 23 deletions docs/graphql.md

This file was deleted.

46 changes: 29 additions & 17 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,47 @@ sidebar_position: 1

# Introduction

### :arrow_right: [Skip to the tutorials](/docs/tutorials/)
Welcome to the D&D 5e SRD API, the Dungeons & Dragons 5th Edition API.

*If you wanna skip right into the tutorial, go ahead. We don't mind!*
This documentation will help you familiarize yourself with the resources available and how to consume them with HTTP requests. Read through the getting started [tutorial](/docs/tutorials/) before you dive in.

### :wave: Welcome
## Base URL

Welcome to the D&D 5e SRD API, the Dungeons & Dragons 5th Edition API!
All API requests are made to the following base URL:

This documentation should help you familiarize yourself with the resources available and how to consume them with HTTP requests. Read through the [Tutorial](/docs/tutorials/) getting started section before you dive in.
```
https://www.dnd5eapi.co/api
```

Most of your problems should be solved just by reading through it.
## Authentication

### :lock: Authentication
This is a completely open API. **No authentication is required to query and get data.** This also means that we've limited what you can do to just `GET`-ing the data.

This is a completely open API. **No authentication is required to query and get data**. This also means that we've limited what you can do to just `GET`-ing the data.
## Rate Limits

If you find a mistake in the data, feel free to [message us](https://discord.gg/TQuYTv7)!
There is a limit of 10,000 requests per second per IP. This is subject to change if something more practical needs to be enforced.

### :smile: Chat
## GraphQL

Come hang out with us [on Discord](https://discord.gg/TQuYTv7)! We're friendly and would love to hear what you make with the API!
This API also supports [GraphQL](https://graphql.org/). The GraphQL endpoint is:

### :handshake: Contribute
```
https://www.dnd5eapi.co/graphql
```

See the [GraphQL tutorial](/docs/tutorials/beginner/graphql) for examples and how to use the Apollo sandbox explorer.

## Community

Come hang out with us [on Discord](https://discord.gg/TQuYTv7). We're friendly and would love to hear what you make with the API.

## Contributing

This API is built from two repositories:

- The repo containing the data lives here: https://github.com/5e-bits/5e-database
- The repo with the API implementation lives here: https://github.com/5e-bits/5e-srd-api
- [5e-database](https://github.com/5e-bits/5e-database) — the data
- [5e-srd-api](https://github.com/5e-bits/5e-srd-api) — the API implementation

This is an evolving API and fresh ideas are always welcome. You can open an issue in either repo, open a PR for changes, or discuss with other users on Discord.

This is a evolving API and having fresh ideas are always welcome! You can
open an issue in either repo, open a PR for changes, or just discuss with
other users in this Discord.
If you find a mistake in the data, feel free to [let us know](https://discord.gg/TQuYTv7).
5 changes: 0 additions & 5 deletions docs/reference/status-page.md

This file was deleted.

33 changes: 16 additions & 17 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,7 @@ const config: Config = {
markdown: {
mermaid: true,
},
themes: [
[
require.resolve("@easyops-cn/docusaurus-search-local"),
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
{
searchBarShortcutHint: false,
},
],
"@docusaurus/theme-mermaid",
],
themes: ["@docusaurus/theme-mermaid"],

// 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
Expand All @@ -50,7 +41,21 @@ const config: Config = {
],
],

plugins: [require.resolve("./src/plugins/dynamic-tutorials-list")],
plugins: [
require.resolve("./src/plugins/dynamic-tutorials-list"),
[
"docusaurus-plugin-llms",
{
generateLLMsTxt: true,
generateLLMsFullTxt: true,
generateMarkdownFiles: true,
docsDir: "docs",
title: "D&D 5e SRD API Documentation",
description:
"REST + GraphQL API for the 5e SRD database. Includes guides, tutorials, API reference, and schema documentation.",
},
],
],

themeConfig: {
languageTabs: [
Expand Down Expand Up @@ -179,12 +184,6 @@ const config: Config = {
position: "left",
dropdownActiveClassDisabled: true,
},
{
type: "doc",
docId: "faq",
position: "left",
label: "FAQ",
},
{
to: "https://5e-bits.github.io/dnd-uptime",
label: "Status",
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"@easyops-cn/docusaurus-search-local": "^0.55.1",
"@mdx-js/react": "^3.1.1",
"clsx": "^2.0.0",
"docusaurus-plugin-llms": "^0.3.0",
"docusaurus-preset-openapi": "^0.8.0",
"prism-react-renderer": "^2.4.0",
"react": "^19.2.4",
Expand Down
2 changes: 1 addition & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
const sidebars: SidebarsConfig = {
referenceSidebar: [
"introduction",
"tutorials/index",
"faq",
{
type: "category",
label: "Reference",
Expand Down
Loading