diff --git a/BirthdayBot.csproj b/BirthdayBot.csproj index bfda17f..023d335 100644 --- a/BirthdayBot.csproj +++ b/BirthdayBot.csproj @@ -36,4 +36,8 @@ + + Docs/**;$(DefaultItemExcludes) + + diff --git a/Docs/.gitignore b/Docs/.gitignore new file mode 100644 index 0000000..f07bd2e --- /dev/null +++ b/Docs/.gitignore @@ -0,0 +1,9 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor + +# Sourced externally; cautiously excluding from repo +# Get it from https://www.flaticon.com/free-icon/birthday-cake_168532 +birthday-cake.png \ No newline at end of file diff --git a/Docs/Gemfile b/Docs/Gemfile new file mode 100644 index 0000000..35d6a52 --- /dev/null +++ b/Docs/Gemfile @@ -0,0 +1,4 @@ +source "https://rubygems.org" +gem "jekyll", "~> 4.3.2" +gem "jekyll-remote-theme" +gem "jekyll-seo-tag" diff --git a/Docs/Gemfile.lock b/Docs/Gemfile.lock new file mode 100644 index 0000000..43cb228 --- /dev/null +++ b/Docs/Gemfile.lock @@ -0,0 +1,82 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.8.1) + public_suffix (>= 2.0.2, < 6.0) + colorator (1.1.0) + concurrent-ruby (1.1.10) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + eventmachine (1.2.7) + ffi (1.15.5) + forwardable-extended (2.6.0) + google-protobuf (3.21.12-x86_64-linux) + http_parser.rb (0.8.0) + i18n (1.12.0) + concurrent-ruby (~> 1.0) + jekyll (4.3.2) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (>= 0.3.6, < 0.5) + pathutil (~> 0.9) + rouge (>= 3.0, < 5.0) + safe_yaml (~> 1.0) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-remote-theme (0.4.3) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.8.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (5.0.1) + rake (13.0.6) + rb-fsevent (0.11.2) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.5) + rouge (4.0.1) + rubyzip (2.3.2) + safe_yaml (1.0.5) + sass-embedded (1.57.1) + google-protobuf (~> 3.21) + rake (>= 10.0.0) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.4.2) + webrick (1.7.0) + +PLATFORMS + x86_64-linux + +DEPENDENCIES + jekyll (~> 4.3.2) + jekyll-remote-theme + jekyll-seo-tag + +BUNDLED WITH + 2.4.5 diff --git a/Docs/_config.yml b/Docs/_config.yml new file mode 100644 index 0000000..88faba3 --- /dev/null +++ b/Docs/_config.yml @@ -0,0 +1,25 @@ +# https://github.com/BDHU/minimalist +title: Birthday Bot +description: A social time zone reference tool! +logo: /birthday-cake.png +show_downloads: false +remote_theme: BDHU/minimalist +color-scheme: dark + +plugins: + - jekyll-remote-theme + +# https://icon-sets.iconify.design/ +sidebar: + - name: Invite the bot + icon: + link: https://discord.com/api/oauth2/authorize?client_id=470673087671566366&permissions=268451840&scope=bot%20applications.commands + - name: Official server + icon: + link: https://discord.gg/JCRyFk7 + - name: GitHub + icon: + link: https://github.com/NoiTheCat/BirthdayBot + - name: Support me on Ko-fi + icon: + link: https://ko-fi.com/noithecat \ No newline at end of file diff --git a/Readme.md b/Docs/index.md similarity index 93% rename from Readme.md rename to Docs/index.md index 26b0cb1..0da5fca 100644 --- a/Readme.md +++ b/Docs/index.md @@ -1,8 +1,10 @@ +--- +layout: default +title: Documentation +--- # Birthday Bot -* Info: https://discord.bots.gg/bots/470673087671566366 - -## Recognize birthdays in your Discord community! +**Recognize birthdays in your Discord community!** Birthday Bot is a simple, single-purpose bot. It will set a role on your users for the duration of their birthdays and, if desired, can announce a message in a channel of your choosing. Server owners can further specify a default time zone, with individual users also setting @@ -49,4 +51,4 @@ server they share with the bot for the servers they wish for it to be known in. Any questions and concerns regarding data and security may be sent to the bot author via the support server or GitHub. #### Image credit -The icon used by this bot is from Flaticon, found at: https://www.flaticon.com/free-icon/birthday-cake_168532 \ No newline at end of file +Cake icons created by Freepik - Flaticon \ No newline at end of file