Git Product home page Git Product logo

javacord.github.io's Introduction

Javacord Website

This is Javacord's github.io page, which hosts our website.

I just want to use Javacord :(

In this case you are wrong here. Just head over to the Javacord repository.

How to run the website locally

Make sure you have RubyGems installed.

gem install bundler jekyll
git clone https://github.com/Javacord/javacord.github.io.git
cd javacord.github.io
bundle exec jekyll serve

How to edit wiki articles

Wiki articles are located in the _wiki folder. They are using simple markdown, which should make it fairly easy to modify them.

How to create wiki articles

A wiki article has the following structure:

---
title: "Article title"
headline: "Article headline"
position: 3
keywords:
- keyword1
- keyword2
---

The content of the article.
  • title: The title of the article, which will be used for the <title> html tag and the side navigation
  • headline: The headline of the article, displayed as <h1>. If not set, the title is used.
  • position: The position of the article in its category. Starting with 1.
  • keywords: A list with keywords used for search. Don't repeat the title or headline here.

How to create changelogs

Changelogs are located in the _changelog folder. They have the following structure:

---
title: "Version x.y.z"
version: x.y.z
---

The content of the changelog.
  • title: The title of the changelog, which will be used for the <title> html tag, usually Version :version:
  • version: The version number

javacord.github.io's People

Contributors

bastian avatar dependabot[bot] avatar mysterypotatoguy avatar vampire avatar walkerknapp avatar

Watchers

 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.