Skip to content

Commit 4cda761

Browse files
TobiasNxTobiasNx
committed
Try out metafacture documentation template for the tutorial
1 parent d587391 commit 4cda761

24 files changed

+626
-69
lines changed

‎.github/workflows/jekyll.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
8+
9+
on:
10+
# Runs on pushes targeting the default branch
11+
push:
12+
branches: ["master"]
13+
14+
# Allows you to run this workflow manually from the Actions tab
15+
workflow_dispatch:
16+
17+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
18+
permissions:
19+
contents: read
20+
pages: write
21+
id-token: write
22+
23+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
24+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
25+
concurrency:
26+
group: "pages"
27+
cancel-in-progress: false
28+
29+
jobs:
30+
# Build job
31+
build:
32+
runs-on: ubuntu-22.04
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v4
36+
- name: Setup Ruby
37+
uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
38+
with:
39+
ruby-version: '3.1' # Not needed with a .ruby-version file
40+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
41+
cache-version: 0 # Increment this number if you need to re-download cached gems
42+
- name: Setup Pages
43+
id: pages
44+
uses: actions/configure-pages@v4
45+
- name: Build with Jekyll
46+
# Outputs to the './_site' directory by default
47+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
48+
env:
49+
JEKYLL_ENV: production
50+
- name: Upload artifact
51+
# Automatically uploads an artifact from the './_site' directory by default
52+
uses: actions/upload-pages-artifact@v3
53+
54+
# Deployment job
55+
deploy:
56+
environment:
57+
name: github-pages
58+
url: ${{ steps.deployment.outputs.page_url }}
59+
runs-on: ubuntu-22.04
60+
needs: build
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
id: deployment
64+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
*.class
2+
3+
# Mobile Tools for Java (J2ME)
4+
.mtj.tmp/
5+
6+
# Package Files #
7+
*.jar
8+
*.war
9+
*.ear
10+
11+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
12+
hs_err_pid*
13+
14+
# Eclipse project config
15+
.settings
16+
.project

‎.vscode/settings.json‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
{
22
"workbench.colorCustomizations": {
3-
"activityBar.activeBackground": "#fc2fce",
4-
"activityBar.activeBorder": "#abdc03",
5-
"activityBar.background": "#fc2fce",
6-
"activityBar.foreground": "#e7e7e7",
7-
"activityBar.inactiveForeground": "#e7e7e799",
8-
"activityBarBadge.background": "#abdc03",
3+
"activityBar.activeBackground": "#7fe280",
4+
"activityBar.background": "#7fe280",
5+
"activityBar.foreground": "#15202b",
6+
"activityBar.inactiveForeground": "#15202b99",
7+
"activityBarBadge.background": "#7e7de2",
98
"activityBarBadge.foreground": "#15202b",
10-
"sash.hoverBorder": "#fc2fce",
11-
"statusBar.background": "#f503bf",
12-
"statusBar.foreground": "#e7e7e7",
13-
"statusBarItem.hoverBackground": "#fc2fce",
14-
"statusBarItem.remoteBackground": "#f503bf",
15-
"statusBarItem.remoteForeground": "#e7e7e7",
16-
"titleBar.activeBackground": "#f503bf",
17-
"titleBar.activeForeground": "#e7e7e7",
18-
"titleBar.inactiveBackground": "#f503bf99",
19-
"titleBar.inactiveForeground": "#e7e7e799",
20-
"commandCenter.border": "#e7e7e799"
9+
"commandCenter.border": "#15202b99",
10+
"sash.hoverBorder": "#7fe280",
11+
"statusBar.background": "#55d957",
12+
"statusBar.foreground": "#15202b",
13+
"statusBarItem.hoverBackground": "#2ecd30",
14+
"statusBarItem.remoteBackground": "#55d957",
15+
"statusBarItem.remoteForeground": "#15202b",
16+
"titleBar.activeBackground": "#55d957",
17+
"titleBar.activeForeground": "#15202b",
18+
"titleBar.inactiveBackground": "#55d95799",
19+
"titleBar.inactiveForeground": "#15202b99"
2120
},
22-
"peacock.color": "#f503bf"
21+
"peacock.color": "#55d957"
2322
}

‎Gemfile‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source 'https://rubygems.org'
2+
3+
gem "jekyll", "~> 4.3.3" # installed by `gem jekyll`
4+
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
5+
6+
gem "just-the-docs", "0.8.1" # pinned to the current release
7+
# gem "just-the-docs" # always download the latest release

‎Gemfile.lock‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
bigdecimal (3.1.9)
7+
colorator (1.1.0)
8+
concurrent-ruby (1.3.5)
9+
em-websocket (0.5.3)
10+
eventmachine (>= 0.12.9)
11+
http_parser.rb (~> 0)
12+
eventmachine (1.2.7)
13+
ffi (1.17.1-x86_64-linux-gnu)
14+
forwardable-extended (2.6.0)
15+
google-protobuf (4.30.2-x86_64-linux)
16+
bigdecimal
17+
rake (>= 13)
18+
http_parser.rb (0.8.0)
19+
i18n (1.14.7)
20+
concurrent-ruby (~> 1.0)
21+
jekyll (4.3.4)
22+
addressable (~> 2.4)
23+
colorator (~> 1.0)
24+
em-websocket (~> 0.5)
25+
i18n (~> 1.0)
26+
jekyll-sass-converter (>= 2.0, < 4.0)
27+
jekyll-watch (~> 2.0)
28+
kramdown (~> 2.3, >= 2.3.1)
29+
kramdown-parser-gfm (~> 1.0)
30+
liquid (~> 4.0)
31+
mercenary (>= 0.3.6, < 0.5)
32+
pathutil (~> 0.9)
33+
rouge (>= 3.0, < 5.0)
34+
safe_yaml (~> 1.0)
35+
terminal-table (>= 1.8, < 4.0)
36+
webrick (~> 1.7)
37+
jekyll-include-cache (0.2.1)
38+
jekyll (>= 3.7, < 5.0)
39+
jekyll-sass-converter (3.1.0)
40+
sass-embedded (~> 1.75)
41+
jekyll-seo-tag (2.8.0)
42+
jekyll (>= 3.8, < 5.0)
43+
jekyll-watch (2.2.1)
44+
listen (~> 3.0)
45+
just-the-docs (0.8.1)
46+
jekyll (>= 3.8.5)
47+
jekyll-include-cache
48+
jekyll-seo-tag (>= 2.0)
49+
rake (>= 12.3.1)
50+
kramdown (2.5.1)
51+
rexml (>= 3.3.9)
52+
kramdown-parser-gfm (1.1.0)
53+
kramdown (~> 2.0)
54+
liquid (4.0.4)
55+
listen (3.9.0)
56+
rb-fsevent (~> 0.10, >= 0.10.3)
57+
rb-inotify (~> 0.9, >= 0.9.10)
58+
mercenary (0.4.0)
59+
pathutil (0.16.2)
60+
forwardable-extended (~> 2.6)
61+
public_suffix (6.0.1)
62+
rake (13.2.1)
63+
rb-fsevent (0.11.2)
64+
rb-inotify (0.11.1)
65+
ffi (~> 1.0)
66+
rexml (3.4.1)
67+
rouge (4.5.1)
68+
safe_yaml (1.0.5)
69+
sass-embedded (1.86.3-x86_64-linux-gnu)
70+
google-protobuf (~> 4.30)
71+
terminal-table (3.0.2)
72+
unicode-display_width (>= 1.1.1, < 3)
73+
unicode-display_width (2.6.0)
74+
webrick (1.9.1)
75+
76+
PLATFORMS
77+
x86_64-linux-gnu
78+
79+
DEPENDENCIES
80+
jekyll (~> 4.3.3)
81+
just-the-docs (= 0.8.1)
82+
83+
BUNDLED WITH
84+
2.4.20

0 commit comments

Comments
 (0)