From 824482288420448247238e2206887c957ba8a8f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=95=E3=82=BA=E3=82=AD?= Date: Thu, 4 Mar 2021 00:54:38 +0100 Subject: [PATCH] Jekyll and repo setup --- .gitignore | 7 +- 404.md | 13 +++ Gemfile | 26 +++++ Gemfile.lock | 273 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 66 ++++++++++++- _config.yml | 20 ++++ index.md | 16 +++ 7 files changed, 417 insertions(+), 4 deletions(-) create mode 100644 404.md create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 _config.yml create mode 100644 index.md diff --git a/.gitignore b/.gitignore index 2ca8682..f40fbd8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -_site/ -.sass-cache/ -.jekyll-cache/ +_site +.sass-cache +.jekyll-cache .jekyll-metadata +vendor diff --git a/404.md b/404.md new file mode 100644 index 0000000..b51534e --- /dev/null +++ b/404.md @@ -0,0 +1,13 @@ +--- +permalink: /404.html +layout: default +--- + +# Page not found + +The page you requested was not found, it may have been moved or removed. + +```tip +You can use the search bar in the sidebar to search through all the +documentation's pages. +``` \ No newline at end of file diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..3b72df6 --- /dev/null +++ b/Gemfile @@ -0,0 +1,26 @@ +# Run locally with: bundle exec jekyll serve +source "https://rubygems.org" + +# gem "jekyll-rtd-theme" + +gem "github-pages", '~> 212', group: :jekyll_plugins +group :jekyll_plugins do + gem "jekyll-default-layout" + gem "jekyll-readme-index" + gem "jekyll-github-metadata" + gem "jekyll-titles-from-headings" + gem "jemoji" + gem "jekyll-avatar" + gem "jekyll-mentions" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", "~> 1.2" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] + diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..6659bb3 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,273 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (6.0.3.5) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + zeitwerk (~> 2.2, >= 2.2.2) + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.8) + dnsruby (1.61.5) + simpleidn (~> 0.1) + em-websocket (0.5.2) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + ethon (0.12.0) + ffi (>= 1.3.0) + eventmachine (1.2.7) + execjs (2.7.0) + faraday (1.3.0) + faraday-net_http (~> 1.0) + multipart-post (>= 1.2, < 3) + ruby2_keywords + faraday-net_http (1.0.1) + ffi (1.14.2) + forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (212) + github-pages-health-check (= 1.17.0) + jekyll (= 3.9.0) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.6) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.15.1) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.13.0) + jekyll-mentions (= 1.6.0) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.16.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.2) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.7.1) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.2) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.12.0) + kramdown (= 2.3.0) + kramdown-parser-gfm (= 1.1.0) + liquid (= 4.0.3) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.10.4, < 2.0) + rouge (= 3.26.0) + terminal-table (~> 1.4) + github-pages-health-check (1.17.0) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (>= 2.0.2, < 5.0) + typhoeus (~> 1.3) + html-pipeline (2.14.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.9.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (>= 1.17, < 3) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.15.1) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.13.0) + jekyll (>= 3.4, < 5.0) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.6.0) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.2) + 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 (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.7.1) + jekyll (>= 3.8, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.2) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.4) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.12.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + kramdown (2.3.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.4.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.14.4) + multipart-post (2.1.1) + nokogiri (1.11.1-x86_64-linux) + racc (~> 1.4) + octokit (4.20.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.6) + racc (1.5.2) + rb-fsevent (0.10.4) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.4) + rouge (3.26.0) + ruby-enum (0.9.0) + i18n + ruby2_keywords (0.0.4) + rubyzip (2.3.0) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + simpleidn (0.2.1) + unf (~> 0.1.4) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (1.2.9) + thread_safe (~> 0.1) + unf (0.1.4) + unf_ext + unf_ext (0.0.7.7) + unicode-display_width (1.7.0) + zeitwerk (2.4.2) + +PLATFORMS + x86_64-linux + +DEPENDENCIES + github-pages (~> 212) + jekyll-avatar + jekyll-default-layout + jekyll-github-metadata + jekyll-mentions + jekyll-readme-index + jekyll-titles-from-headings + jemoji + tzinfo (~> 1.2) + tzinfo-data + wdm (~> 0.1.1) + +BUNDLED WITH + 2.2.13 diff --git a/README.md b/README.md index 77f2a74..4865780 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ # Documentation -User-made documentation for GooseMod + +User-made documentation for [GooseMod](https://goosemod.com). + +[View the documentation](https://keanugoosemod.github.io/Documentation). + +## Adding content + +To add content to this documentation, first fork it to have your own copy of +the repo. Clone your fork and make your edits there. + +To add a page, add a MarkDown `.md` file to one of the categories +(eg: `module-development/`). + +You can also add your own category by adding a directory with a `README.md` +file inside, that describes what your category is about and lists the +category's files by adding this line: +``` +{% include list.liquid all=true %} +``` + +By default Jekyll will pull the first title as the page's title, but that can +be overwritten with front matter at the top of your page: +```yaml +--- +title: Your title +# other front matter definitions +--- +``` + +To sort a category's pages, add a `sort` property to the pages' front matter +section: +```yaml +--- +# other front matter definitions +sort: +--- +``` + +## Updating the documentation website + +Before pushing your edits to the documentation, you may want to see what they +look like. To do so, you need to: +- have a local [Ruby](https://www.ruby-lang.org) environment +- install the `bundler` and `jekyll` gems + `gem install bundler jekyll` +- install this project's specific requirements: + `bundle install` (or `bundle update` if you already built it before) +- run Jekyll: + `bundle exec jekyll serve` +- open the address that is returned on the terminal in your browser + (usually `http://127.0.0.1:4000/`) + +To push your modifications to the documentation, push your modifications to +your fork and submit a pull request to this one. + +No particular operation is needed, [Github Pages](https://pages.github.com) +will update the documentation's website whenever commits are pushed to this +repo. + +## Additional resources + +- GH Pages: [Github Pages docs](https://docs.github.com/en/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll) +- Generator: [Jekyll docs](https://jekyllrb.com/docs/) +- Theme: [jekyll-rtd-theme](https://jekyll-rtd-theme.rundocs.io/) and + [rundocs.io](https://rundocs.io/) \ No newline at end of file diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..61891f7 --- /dev/null +++ b/_config.yml @@ -0,0 +1,20 @@ +title: GM User Docs +email: your-email@example.com +description: >- + A collection of user made documentation entries for the GooseMod Discord + modification. +baseurl: "" # the subpath of your site, e.g. /blog +url: "" # the base hostname & protocol for your site, e.g. http://example.com +twitter_username: jekyllrb +github_username: jekyll + +# theme: jekyll-rtd-theme +remote_theme: rundocs/jekyll-rtd-theme +plugins: + - jekyll-default-layout + - jekyll-readme-index + - jekyll-github-metadata + - jekyll-titles-from-headings + - jemoji + - jekyll-avatar + - jekyll-mentions diff --git a/index.md b/index.md new file mode 100644 index 0000000..702e623 --- /dev/null +++ b/index.md @@ -0,0 +1,16 @@ +# GooseMod user-made documentation + +## What is GooseMod + +[GooseMod](https://goosemod.com/) is a lightweight modification for +[Discord](https://discord.com/). + +## Purpose of this documentation + +GooseMod is very easy to pick up as a user, but some aspects like module +development aren't as easy to get into unless you enjoy filtering and reading +other people's code. Whilst there is an +[official documentation](https://github.com/GooseMod/Docs) in the works, this +is a collection of things we learnt while making modules for fun. It is not +meant to replace the official documentation, but rather complete it or document +what has yet not been documented there. \ No newline at end of file