Giter VIP home page Giter VIP logo

shokosite's Introduction

Shoko Website

As with everything else, our website is open-source so if you feel a change needs to be made, submit a PR. There are a few things to keep in mind which we've outlined below.

Jekyll Framework

The Shoko website is built using Jekyll and will probably be required if you plan to make any major changes. Please check the Jekyll website to learn how to install and properly setup Jekyll, do not ask us for support.

Adding A New Blog Post

Blog posts are generally reserved for Shoko related announcements but can be created by program / plugin authors to inform users about a recently released update. Your blog post should contain relevant details about the update and not act as a glorified link to your own site or repo.

Blog posts are located in the _posts folder, we recommend taking a look at an existing blog post for file naming and structure setup.

If you'd like to make a blog post and have questions, please contact Elemental Crisis on the Shoko Discord for more information.

Adding / Updating A Program / Plugin

Adding a new program or plugin.

  1. Create a new folder in assets/images/programs-plugins with the name of your program / plugin.
  2. Place all relevant images within that folder, file names should be The-File-Name and saved as .JPG files.
  3. Copy an existing program / plugin's data in _data/downloads.yml, paste it at the bottom of the file and make all relevant changes. Make sure to not change the formatting as YAML is very specific on its formatting and will not compile if incorrect.
  4. Build Jekyll, if it works then create a PR, if not then fix the error.

Updating a program or plugin.

  1. Open _data/downloads.yml and modify the program / plugin data as needed. Make sure to not change the formatting as YAML is very specific on its formatting and will not compile if incorrect.
  2. If you need to update images, make sure file names are named as The-File-Name and saved as .JPG files.
  3. Build Jekyll, if it works then create a PR, if not then fix the error.

Please note, small Jekyll related issues will probably be overlooked and fixed by staff as we don't want Jekyll to be the holdup when submitting a program / plugin. Just try not to break everything.

shokosite's People

Contributors

elementalcrisis avatar bigretromike avatar hidden4003 avatar

Watchers

James Cloos avatar  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.