Giter VIP home page Giter VIP logo

guide's Introduction

Pycord Guide

Netlify Status

The official Guide for Pycord, explaining Pycord's features and how to use them.

The website is built using Docusaurus 2, a modern static website generator.

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.

The Guide is built using Docusaurus 2, a modern static website generator.

/src contains styling (.scss) and the index (.tsx/jsx).

/docs contains the pages for the guide. The Guide Pages are writtern 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=<Your GitHub username> 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.

guide's People

Contributors

bobdotcom avatar brucecodesgithub avatar dependabot[bot] avatar dorukyum avatar dtheicydragon avatar emretech avatar enokiun avatar hannesrahn avatar iddev5 avatar itsnotrin avatar jab416171 avatar justasqu1d avatar krittick avatar lulalaby avatar martinbndr avatar matteusan avatar middledot avatar neloblivion avatar ombucha avatar sengolda avatar tibue99 avatar tommodev-ctrl avatar tunayadakaracan avatar vincentrps avatar whoisconch avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.