Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/src/.vuepress/dist
commit_message: ${{ github.event.head_commit.message }}
cname: harmony.mod.land
cname: harmony-korean.mod.land
keep_files: true
enable_jekyll: false
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
harmony.mod.land
harmony-korean.mod.land
10 changes: 4 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
"description": "An easy to use, advanced Discord API library, for Deno.",
"main": "index.js",
"authors": {
"name": "DjDeveloperr",
"email": "[email protected]"
"name": "Harmony org"
},
"repository": "guide/harmony-guide",
"scripts": {
Expand All @@ -14,11 +13,10 @@
},
"license": "MIT",
"devDependencies": {
"vuepress": "^1.5.3",
"vuepress-theme-yuu": "^2.3.0"
"vuepress": "^1.5.3"
},
"dependencies": {
"vuepress-theme-default-prefers-color-scheme": "^2.0.0",
"vuepress-theme-yuu": "^2.3.0"
"vuepress-theme-yuu": "^2.3.0",
"vuepress-theme-default-prefers-color-scheme": "^2.0.0"
}
}
173 changes: 121 additions & 52 deletions src/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
const { description } = require('../../package')

module.exports = {
/**
* Ref:https://v1.vuepress.vuejs.org/config/#title
*/
title: 'Harmony',
/**
* Ref:https://v1.vuepress.vuejs.org/config/#description
*/
description: description,
locales: {
'/': {
lang: 'en-US',
/**
* Ref:https://v1.vuepress.vuejs.org/config/#title
*/
title: 'Harmony',
/**
* Ref:https://v1.vuepress.vuejs.org/config/#description
*/
description: description,
},
'/ko/': {
lang: 'ko-KR',
title: 'Harmony',
description: 'Deno를 위한, 사용하기 쉬우면서, 매우 고급지고, 조화로운 Discord API 라이브러리입니다.'
}
},

/**
* Extra tags to be injected to the page HTML `<head>`
Expand All @@ -27,52 +37,111 @@ module.exports = {
* ref:https://v1.vuepress.vuejs.org/theme/default-theme-config.html
*/
themeConfig: {
repo: 'https://github.com/harmonyland/harmonyland.github.io',
editLinks: true,
docsDir: 'src',
docsBranch: 'main',
editLinkText: 'Edit this page',
lastUpdated: true,
nav: [
{
text: 'Guide',
link: '/guide/',
},
{
text: 'Documentation',
link: 'https://doc.deno.land/https/deno.land/x/harmony/mod.ts',
locales: {
'/': {
selectText: 'Languages',
label: 'English',
ariaLabel: 'Languages',
algolia: {},
repo: 'https://github.com/harmonyland/harmonyland.github.io',
editLinks: true,
docsDir: 'src',
docsBranch: 'main',
editLinkText: 'Edit this page',
lastUpdated: true,
nav: [
{
text: 'Guide',
link: '/guide/',
},
{
text: 'Documentation',
link: 'https://doc.deno.land/https/deno.land/x/harmony/mod.ts',
},
{
text: 'Discord',
link: 'https://discord.gg/harmony'
}
],
sidebar: {
'/guide/': [
{
title: 'Home',
collapsable: false,
children: [
'',
'setup'
]
},
{
title: 'Beginner',
collapsable: false,
children: [
'beginner/basic_bot',
]
},
{
title: 'Slash Commands',
collapsable: false,
children: [
'slash_commands/tag_bot'
]
}
],
}
},
{
text: 'Discord',
link: 'https://discord.gg/WVN2JF2FRv'
}
],
sidebar: {
'/guide/': [
{
title: 'Home',
collapsable: false,
children: [
'',
'setup'
]
},
{
title: 'Beginner',
collapsable: false,
children: [
'beginner/basic_bot',
]
},
{
title: 'Slash Commands',
collapsable: false,
children: [
'slash_commands/tag_bot'
]
'/ko/': {
selectText: '언어',
label: '한국어',
algolia: {},
repo: 'https://github.com/harmonyland/harmonyland.github.io',
editLinks: true,
docsDir: 'src/ko',
docsBranch: 'main',
editLinkText: '이 페이지를 편집하기',
lastUpdated: true,
nav: [
{
text: '가이드',
link: '/ko/guide/',
},
{
text: '문서',
link: 'https://doc.deno.land/https/deno.land/x/harmony/mod.ts',
},
{
text: '디스코드',
link: 'https://discord.gg/harmony'
}
],
sidebar: {
'/ko/guide/': [
{
title: '홈',
collapsable: false,
children: [
'',
'setup'
]
},
{
title: '초보자',
collapsable: false,
children: [
'beginner/basic_bot',
]
},
{
title: '슬래시 커맨드',
collapsable: false,
children: [
'slash_commands/tag_bot'
]
}
],
}
],
}
}
},
},

theme: 'yuu',
Expand Down
33 changes: 33 additions & 0 deletions src/ko/guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 소개

![BANNER](https://camo.githubusercontent.com/7d1d4666f64be79ec842ddcfcaf0848c758e16da2c2e30083e5a6c61475ec994/68747470733a2f2f63646e2e646973636f72646170702e636f6d2f6174746163686d656e74732f3738333331393033333733303536343039382f3738333339393031323534373033353137362f4861726d6f6e7942616e6e65722e706e67)

If you're reading this, you probably want to create Discord bots! Who doesn't agree these bots can do cool stuff, but hey - how exactly do we go about making these? It's simple, or maybe not! Depends on how you take it. Many people start programming with Discord bots - and me too, honestly. First off, if you already know a language which is not JavaScript/TypeScript, you should consider using the library for that language, yes for real. It would be easier for you to get started, else, this guide is absolutely for you!

Here's a list of [libraries for Discord API](https://discord.com/developers/docs/topics/community-resources#libraries-discord-libraries). If you couldn't find one for you, let's continue! JavaScript (or TypeScript) aren't hard to learn.

What exactly is Harmony? It's an easy to use, and advanced Discord API Library, for Deno. It's designed to be easy to use, as well as to offer everything an advanced developer may need. If you don't know about [Deno](https://deno.land) yet, in a nutshell, it's a secure JavaScript/TypeScript runtime made in Rust. *You can call it new, or better Node.*

In this guide, you'll learn about various concepts, but here's an overview
- How to get a bot up and running from scratch
- How to keep your code organized
- Learn about best practices
- More advanced concepts
- ... and much more.

## 시작하기 전에...

It's possible that you want to get started with bot development, but don't know any programming language. However, we recommend you to learn basics else you'll be tackling with problems with are actually so small! It doesn't take much time, here are some good resources to get started with JavaScript...

- [모던 JavaScript ](https://javascript.info/)
- [MDN's JavaScript guide and Documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [CodeCademy JavaScript course](https://www.codecademy.com/learn/learn-javascript)
- And honestly, [Stack Overflow](https://stackoverflow.com) will be solving many problems for you

However, it's worth considering that Harmony is made using [TypeScript](https://www.typescriptlang.org/), which is a subset of JavaScript, but strongly-typed, and we are also using **TypeScript** throughout the guide for code examples. It helps you write more concise, less error prone code, and also adds on some new features! At the end, it compiles (transpiles!) to normal JavaScript. We recommend using TypeScript for its great features and Deno's built-in TypeScript! Here are some resources,

- [TypeScript's Docs for Beginners](https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html)
- [TypeScript's Docs for JS Programmers](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html)
- [Educative's TypeScript tutorial](https://www.educative.io/blog/typescript-tutorial)

If you have never used [Deno](https://deno.land) before, you might want to consider reading [Deno Manual](https://deno.land/manual) and a gentle introduction to the runtime and it's features.
Loading