Skip to content
This repository has been archived by the owner on Mar 19, 2023. It is now read-only.

Latest commit

 

History

History
168 lines (125 loc) · 5.09 KB

README.md

File metadata and controls

168 lines (125 loc) · 5.09 KB
Raw

The Newbie Club Graphic Designing Encyclopedia

Official GFX Encyclopedia by The Newbie Club.



Explore the docs »


Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact

About The Project

Currently, GFX section on The Newbie Club use Google Docs for the documentations. However, due to limitation on the software itself, we decided to make new one and made our documentation to be public.

This project contains different information that will help staff as a graphic designer and/or card deliverer for The Newbie Club.

Built With

We use docsify, npm, and markdownlint to make it possible.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Below list things you need to use the software and how to install them.

Installation

  1. Fork this repo

  2. Clone the repo

    git clone https://github.com/<YOUR USERNAME>/gfxEncyclopedia.git

  3. Install npm packages

    npm install

Development

  1. Check if node dependencies up-to-date

  2. Run markdownlint

    • Only linting:

      npm run lint

    • Linting + preview docsify

      npm run proofread

  3. Run lychee

    npm run validatelink

    or

    lychee -v -c "./config/lychee.toml" "**/*.md" "**/*.html" -b .

    Warning

    1. This command probably will check any links available in node_modules/, unfortunately lychee does not have support to ignore path yet. Use with your own risk.
      • We will update the instruction when "ignore path" featured to the software.
    2. You can bypass this behavior by moving node_modules/ directory outside working directory temporarily.
    3. However, link will also be checked through GitHub Action available on this repo (which does not include node_modules/ by default.).

Contributing

Please head to contributing.md for more detailed information. We use modified Ryuuganime contribution guideline under Creative Commmons Zero v1.0 International.

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct version 2.0. By participating, you are expected to uphold this code. For detailed information, read CODE_OF_CONDUCT.md.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Maintainer

Natsu Tadama (@nattadasu) — hello@nattadasu.my.id

Organization

The Newbie Club
MyAnimeList Club Page — Discord Server
contact@thenewbieclub.net