{"id":27949470,"url":"https://github.com/pycord-development/guide","last_synced_at":"2025-05-07T15:28:01.419Z","repository":{"id":37263649,"uuid":"451111757","full_name":"Pycord-Development/guide","owner":"Pycord-Development","description":"The official guide for Pycord","archived":false,"fork":false,"pushed_at":"2025-04-03T01:26:29.000Z","size":4746,"stargazers_count":75,"open_issues_count":17,"forks_count":57,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-03T02:27:02.402Z","etag":null,"topics":["guide","hacktoberfest","pycord","react"],"latest_commit_sha":null,"homepage":"https://guide.pycord.dev","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pycord-Development.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"pycord"}},"created_at":"2022-01-23T13:26:51.000Z","updated_at":"2025-04-03T01:24:40.000Z","dependencies_parsed_at":"2024-02-05T22:30:00.971Z","dependency_job_id":"3d64fc6d-b7b1-4c64-a3e8-67780f3d2346","html_url":"https://github.com/Pycord-Development/guide","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pycord-Development%2Fguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pycord-Development%2Fguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pycord-Development%2Fguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pycord-Development%2Fguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pycord-Development","download_url":"https://codeload.github.com/Pycord-Development/guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252904795,"owners_count":21822675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["guide","hacktoberfest","pycord","react"],"created_at":"2025-05-07T15:28:00.125Z","updated_at":"2025-05-07T15:28:01.414Z","avatar_url":"https://github.com/Pycord-Development.png","language":"MDX","readme":"# Pycord Guide\n\nThe official Guide for Pycord, explaining Pycord's features and how to use them.\n\n## Purpose\n\nThe Guide is meant to serve as a professional guide to **all** of Pycord's features.\nThis also means that everything is critiqued to end up at the best quality.\nIf a part of the guide doesn't make these expectations\nit will either be refactored, or redone.\n\n## Contributing\n\nFor contributing rules, please visit [this page](./CONTRIBUTING.md).\n\nThe Guide is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. \n\n[`/src`](./src) contains styling (`.scss`) and the index (`.tsx`/`jsx`).\n\n[`/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.\n\n## Local Development\n\nFirst, you need to clone the repository:\n\n    git clone https://github.com/Pycord-Development/guide\n\n### Installing Requirements\n\nYou need to install the requirements for the guide, which you may do by running the following command:\n\n    yarn\n\n### Starting the Server\n\nThen, you can start the server by running the following command:\n\n    yarn start\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Building the Website\n\nThen, you can build the website by running the following command:\n\n    yarn build\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n### Deployment\n\nUsing SSH:\n\n    USE_SSH=true yarn deploy\n\nWithout SSH:\n\n    GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n\nIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.\n\n\u003c!-- Redeploy --\u003e\n","funding_links":["https://patreon.com/pycord"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycord-development%2Fguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpycord-development%2Fguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycord-development%2Fguide/lists"}