Official GFX Encyclopedia by The Newbie Club.
Explore the docs »
Table of Contents
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.
We use docsify
, npm
, and
markdownlint
to make it possible.
To get a local copy up and running follow these simple example steps.
Below list things you need to use the software and how to install them.
-
lycheeverse/lychee
Used for link checking.
-
Fork this repo
-
Clone the repo
git clone https://github.com/<YOUR USERNAME>/gfxEncyclopedia.git
-
Install
npm
packagesnpm install
-
Check if node dependencies up-to-date
-
Run
markdownlint
-
Only linting:
npm run lint
-
Linting + preview
docsify
npm run proofread
-
-
Run
lychee
npm run validatelink
or
lychee -v -c "./config/lychee.toml" "**/*.md" "**/*.html" -b .
- This command probably will check any links available in
node_modules/
, unfortunatelylychee
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.
- You can bypass this behavior by moving
node_modules/
directory outside working directory temporarily. - However, link will also be checked through GitHub Action available on this repo (which does
not include
node_modules/
by default.).
- This command probably will check any links available in
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.
Distributed under the MIT License. See LICENSE
for more information.
Natsu Tadama (@nattadasu) — [email protected]
The Newbie Club
MyAnimeList Club Page — Discord Server
[email protected]