https://github.com/botlabs-gg/yagpdb-docs-v2

YAGPDB's (new) documentation and custom commands course.
https://github.com/botlabs-gg/yagpdb-docs-v2

documentation yagpdb yagpdb-cc yagpdb-ccs yagpdb-discord-bot

Last synced: about 1 year ago
JSON representation

YAGPDB's (new) documentation and custom commands course.

• Host: GitHub
• URL: https://github.com/botlabs-gg/yagpdb-docs-v2
• Owner: botlabs-gg
• License: cc-by-sa-4.0
• Created: 2023-12-19T20:56:16.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2025-06-16T08:34:23.000Z (about 1 year ago)
• Last Synced: 2025-06-16T09:52:14.431Z (about 1 year ago)
• Topics: documentation, yagpdb, yagpdb-cc, yagpdb-ccs, yagpdb-discord-bot
• Language: Markdown
• Homepage: http://help.yagpdb.xyz/
• Size: 9.98 MB
• Stars: 10
• Watchers: 3
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# YAGPDB Docs v2

Experimental / proof of concept page to replace the current documentation which is built with GitBook.

This documentation is built with [Hugo](https://gohugo.io) in conjunction with the [Doks theme](https://getdoks.org/) as

an experiment to see if it is a viable alternative.

## Contributing / Building

Install [Node.js](https://nodejs.org/en), clone this repository, install the dependencies with `npm install`, and run

`npm run dev` to start a local server. The server will automatically rebuild the page when you make changes.

To build the page in release mode, use `HUGO_BASEURL=... npm run build`, then serve the generated `public/` directory

with your webserver of choice.

For more information, please view our [Contributing Guidelines](.github/CONTRIBUTING.md).

### Editor Setup

As this project uses the [EditorConfig](https://editorconfig.org/) standard, you will have to make sure that your

editor supports it. Most modern editors do, but if you are unsure, check the EditorConfig page.

### Authoring Content

Pages are written in Markdown with additional shortcodes provided by the Doks theme; refer to [its

documentation](<(https://getdoks.org/docs/start-here/getting-started/)>) for a complete list of features.

If you are editing pages related to custom commands, note that codeblocks support a custom `yag` language for accurate

syntax highlighting—do not use `go`. However, this feature is only enabled in production builds for performance, so

`npm run dev` will _not_ highlight `yag` codeblocks. Use `npm run build` followed by `npm run preview` instead if you

need to verify that code is highlighted correctly.

> [!TIP]

> If you use VSCode, this project provides custom workspace snippets to insert callouts, which you can activate in

> Markdown files by typing Ctrl + Space followed by `note`, `tip`, `warning`, or `danger`.

## License

This documentation's text is distributed under the terms of the Creative Commons Attribution ShareAlike 4.0 license

(SPDX-indentifer `CC-BY-SA`). Please view the [LICENSE](LICENSE) file for more information.