https://github.com/pycord-development/guide
The official guide for Pycord
https://github.com/pycord-development/guide
guide hacktoberfest pycord react
Last synced: 8 months ago
JSON representation
The official guide for Pycord
- Host: GitHub
- URL: https://github.com/pycord-development/guide
- Owner: Pycord-Development
- License: mit
- Created: 2022-01-23T13:26:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-03T01:26:29.000Z (9 months ago)
- Last Synced: 2025-04-03T02:27:02.402Z (9 months ago)
- Topics: guide, hacktoberfest, pycord, react
- Language: MDX
- Homepage: https://guide.pycord.dev
- Size: 4.53 MB
- Stars: 75
- Watchers: 5
- Forks: 57
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Pycord Guide
The official Guide for Pycord, explaining Pycord's features and how to use them.
## Purpose
The Guide is meant to serve as a professional guide to **all** of Pycord's features.
This also means that everything is critiqued to end up at the best quality.
If a part of the guide doesn't make these expectations
it will either be refactored, or redone.
## Contributing
For contributing rules, please visit [this page](./CONTRIBUTING.md).
The Guide is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
[`/src`](./src) contains styling (`.scss`) and the index (`.tsx`/`jsx`).
[`/docs`](./docs) contains the pages for the guide. The Guide Pages are written in the `mdx` file format, a combination of Markdown syntax and JSX/React.
## Local Development
First, you need to clone the repository:
git clone https://github.com/Pycord-Development/guide
### Installing Requirements
You need to install the requirements for the guide, which you may do by running the following command:
yarn
### Starting the Server
Then, you can start the server by running the following command:
yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Building the Website
Then, you can build the website by running the following command:
yarn build
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
USE_SSH=true yarn deploy
Without SSH:
GIT_USER= yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.