Skip to content

Commit aebb267

Browse files
levalleux-ludolevalleux-ludo
authored
feat: add GH page generation for end-users tutorials (#1163)
1 parent 8262410 commit aebb267

File tree

94 files changed

+1381
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+1381
-0
lines changed

‎.github/workflows/jekyll-gh-pages.yml‎

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

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,9 @@ test-results.json
3333
.vscode
3434
codecov
3535
.qodo
36+
37+
_site
38+
.sass-cache
39+
.jekyll-cache
40+
.jekyll-metadata
41+
vendor

‎docs/404.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: page
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

‎docs/Gemfile‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 4.4.1"
11+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
12+
gem "minima", "~> 2.5"
13+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
14+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
15+
# gem "github-pages", group: :jekyll_plugins
16+
# If you have any plugins, put them here!
17+
group :jekyll_plugins do
18+
gem "jekyll-feed", "~> 0.12"
19+
20+
end
21+
22+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
23+
# and associated library.
24+
platforms :mingw, :x64_mingw, :mswin, :jruby do
25+
gem "tzinfo", ">= 1", "< 3"
26+
gem "tzinfo-data"
27+
end
28+
29+
# Performance-booster for watching directories on Windows
30+
gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
31+
32+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
33+
# do not have a Java counterpart.
34+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
35+
36+
# From https://github.com/just-the-docs/just-the-docs?tab=readme-ov-file#use-as-a-ruby-gem
37+
gem "just-the-docs"
38+
39+
# From https://github.com/jekyll/jekyll-sitemap
40+
gem "jekyll-sitemap"
41+
42+
# From https://github.com/jekyll/jekyll-watch
43+
gem "jekyll-watch"
44+
45+
# From https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
46+
gem "jekyll-default-layout"

‎docs/Gemfile.lock‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
base64 (0.3.0)
7+
bigdecimal (3.3.1)
8+
colorator (1.1.0)
9+
concurrent-ruby (1.3.5)
10+
csv (3.3.5)
11+
em-websocket (0.5.3)
12+
eventmachine (>= 0.12.9)
13+
http_parser.rb (~> 0)
14+
eventmachine (1.2.7)
15+
ffi (1.17.2)
16+
ffi (1.17.2-aarch64-linux-gnu)
17+
ffi (1.17.2-aarch64-linux-musl)
18+
ffi (1.17.2-arm-linux-gnu)
19+
ffi (1.17.2-arm-linux-musl)
20+
ffi (1.17.2-arm64-darwin)
21+
ffi (1.17.2-x86-linux-gnu)
22+
ffi (1.17.2-x86-linux-musl)
23+
ffi (1.17.2-x86_64-darwin)
24+
ffi (1.17.2-x86_64-linux-gnu)
25+
ffi (1.17.2-x86_64-linux-musl)
26+
forwardable-extended (2.6.0)
27+
google-protobuf (4.33.1)
28+
bigdecimal
29+
rake (>= 13)
30+
google-protobuf (4.33.1-aarch64-linux-gnu)
31+
bigdecimal
32+
rake (>= 13)
33+
google-protobuf (4.33.1-aarch64-linux-musl)
34+
bigdecimal
35+
rake (>= 13)
36+
google-protobuf (4.33.1-arm64-darwin)
37+
bigdecimal
38+
rake (>= 13)
39+
google-protobuf (4.33.1-x86-linux-gnu)
40+
bigdecimal
41+
rake (>= 13)
42+
google-protobuf (4.33.1-x86-linux-musl)
43+
bigdecimal
44+
rake (>= 13)
45+
google-protobuf (4.33.1-x86_64-darwin)
46+
bigdecimal
47+
rake (>= 13)
48+
google-protobuf (4.33.1-x86_64-linux-gnu)
49+
bigdecimal
50+
rake (>= 13)
51+
google-protobuf (4.33.1-x86_64-linux-musl)
52+
bigdecimal
53+
rake (>= 13)
54+
http_parser.rb (0.8.0)
55+
i18n (1.14.7)
56+
concurrent-ruby (~> 1.0)
57+
jekyll (4.4.1)
58+
addressable (~> 2.4)
59+
base64 (~> 0.2)
60+
colorator (~> 1.0)
61+
csv (~> 3.0)
62+
em-websocket (~> 0.5)
63+
i18n (~> 1.0)
64+
jekyll-sass-converter (>= 2.0, < 4.0)
65+
jekyll-watch (~> 2.0)
66+
json (~> 2.6)
67+
kramdown (~> 2.3, >= 2.3.1)
68+
kramdown-parser-gfm (~> 1.0)
69+
liquid (~> 4.0)
70+
mercenary (~> 0.3, >= 0.3.6)
71+
pathutil (~> 0.9)
72+
rouge (>= 3.0, < 5.0)
73+
safe_yaml (~> 1.0)
74+
terminal-table (>= 1.8, < 4.0)
75+
webrick (~> 1.7)
76+
jekyll-default-layout (0.1.5)
77+
jekyll (>= 3.0, < 5.0)
78+
jekyll-feed (0.17.0)
79+
jekyll (>= 3.7, < 5.0)
80+
jekyll-include-cache (0.2.1)
81+
jekyll (>= 3.7, < 5.0)
82+
jekyll-sass-converter (3.1.0)
83+
sass-embedded (~> 1.75)
84+
jekyll-seo-tag (2.8.0)
85+
jekyll (>= 3.8, < 5.0)
86+
jekyll-sitemap (1.4.0)
87+
jekyll (>= 3.7, < 5.0)
88+
jekyll-watch (2.2.1)
89+
listen (~> 3.0)
90+
json (2.16.0)
91+
just-the-docs (0.10.1)
92+
jekyll (>= 3.8.5)
93+
jekyll-include-cache
94+
jekyll-seo-tag (>= 2.0)
95+
rake (>= 12.3.1)
96+
kramdown (2.5.1)
97+
rexml (>= 3.3.9)
98+
kramdown-parser-gfm (1.1.0)
99+
kramdown (~> 2.0)
100+
liquid (4.0.4)
101+
listen (3.9.0)
102+
rb-fsevent (~> 0.10, >= 0.10.3)
103+
rb-inotify (~> 0.9, >= 0.9.10)
104+
mercenary (0.4.0)
105+
minima (2.5.2)
106+
jekyll (>= 3.5, < 5.0)
107+
jekyll-feed (~> 0.9)
108+
jekyll-seo-tag (~> 2.1)
109+
pathutil (0.16.2)
110+
forwardable-extended (~> 2.6)
111+
public_suffix (6.0.2)
112+
rake (13.3.1)
113+
rb-fsevent (0.11.2)
114+
rb-inotify (0.11.1)
115+
ffi (~> 1.0)
116+
rexml (3.4.4)
117+
rouge (4.6.1)
118+
safe_yaml (1.0.5)
119+
sass-embedded (1.94.1)
120+
google-protobuf (~> 4.31)
121+
rake (>= 13)
122+
sass-embedded (1.94.1-aarch64-linux-android)
123+
google-protobuf (~> 4.31)
124+
sass-embedded (1.94.1-aarch64-linux-gnu)
125+
google-protobuf (~> 4.31)
126+
sass-embedded (1.94.1-aarch64-linux-musl)
127+
google-protobuf (~> 4.31)
128+
sass-embedded (1.94.1-arm-linux-androideabi)
129+
google-protobuf (~> 4.31)
130+
sass-embedded (1.94.1-arm-linux-gnueabihf)
131+
google-protobuf (~> 4.31)
132+
sass-embedded (1.94.1-arm-linux-musleabihf)
133+
google-protobuf (~> 4.31)
134+
sass-embedded (1.94.1-arm64-darwin)
135+
google-protobuf (~> 4.31)
136+
sass-embedded (1.94.1-riscv64-linux-android)
137+
google-protobuf (~> 4.31)
138+
sass-embedded (1.94.1-riscv64-linux-gnu)
139+
google-protobuf (~> 4.31)
140+
sass-embedded (1.94.1-riscv64-linux-musl)
141+
google-protobuf (~> 4.31)
142+
sass-embedded (1.94.1-x86_64-darwin)
143+
google-protobuf (~> 4.31)
144+
sass-embedded (1.94.1-x86_64-linux-android)
145+
google-protobuf (~> 4.31)
146+
sass-embedded (1.94.1-x86_64-linux-gnu)
147+
google-protobuf (~> 4.31)
148+
sass-embedded (1.94.1-x86_64-linux-musl)
149+
google-protobuf (~> 4.31)
150+
terminal-table (3.0.2)
151+
unicode-display_width (>= 1.1.1, < 3)
152+
unicode-display_width (2.6.0)
153+
webrick (1.9.1)
154+
155+
PLATFORMS
156+
aarch64-linux-android
157+
aarch64-linux-gnu
158+
aarch64-linux-musl
159+
arm-linux-androideabi
160+
arm-linux-gnu
161+
arm-linux-gnueabihf
162+
arm-linux-musl
163+
arm-linux-musleabihf
164+
arm64-darwin
165+
riscv64-linux-android
166+
riscv64-linux-gnu
167+
riscv64-linux-musl
168+
ruby
169+
x86-linux-gnu
170+
x86-linux-musl
171+
x86_64-darwin
172+
x86_64-linux-android
173+
x86_64-linux-gnu
174+
x86_64-linux-musl
175+
176+
DEPENDENCIES
177+
http_parser.rb (~> 0.6.0)
178+
jekyll (~> 4.4.1)
179+
jekyll-default-layout
180+
jekyll-feed (~> 0.12)
181+
jekyll-sitemap
182+
jekyll-watch
183+
just-the-docs
184+
minima (~> 2.5)
185+
tzinfo (>= 1, < 3)
186+
tzinfo-data
187+
wdm (~> 0.1)
188+
189+
BUNDLED WITH
190+
2.7.2

‎docs/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: page
3+
title: Quick Start
4+
permalink: /readme/
5+
description: Try out our decentralized marketplace
6+
nav_order: 2
7+
---
8+
9+
# Quick start tutorials
10+

0 commit comments

Comments
 (0)