Skip to content

Commit 6d20ab1

Browse files
AklakanAklakan
committed
Added just-the-docs site
1 parent 06a0533 commit 6d20ab1

File tree

7 files changed

+245
-0
lines changed

7 files changed

+245
-0
lines changed

‎.github/dependabot.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: bundler
4+
directory: /
5+
schedule:
6+
interval: daily
7+
allow:
8+
- dependency-type: direct

‎.github/workflows/ci.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- "develop"
7+
pull_request:
8+
9+
jobs:
10+
# Build job
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v3
16+
- name: Setup Ruby
17+
uses: ruby/setup-ruby@v1
18+
with:
19+
ruby-version: '3.1' # Not needed with a .ruby-version file
20+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
21+
cache-version: 0 # Increment this number if you need to re-download cached gems
22+
working-directory: '${{ github.workspace }}/docs'
23+
- name: Build with Jekyll
24+
run: bundle exec jekyll build
25+
working-directory: '${{ github.workspace }}/docs'
26+

‎.github/workflows/pages.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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+
push:
11+
branches:
12+
- "develop"
13+
paths:
14+
- "docs/**"
15+
# Allows you to run this workflow manually from the Actions tab
16+
workflow_dispatch:
17+
18+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
19+
permissions:
20+
contents: read
21+
pages: write
22+
id-token: write
23+
24+
# Allow one concurrent deployment
25+
concurrency:
26+
group: "pages"
27+
cancel-in-progress: true
28+
29+
jobs:
30+
# Build job
31+
build:
32+
runs-on: ubuntu-latest
33+
defaults:
34+
run:
35+
working-directory: docs
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v3
39+
- name: Setup Ruby
40+
uses: ruby/setup-ruby@v1
41+
with:
42+
ruby-version: '3.1' # Not needed with a .ruby-version file
43+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
44+
cache-version: 0 # Increment this number if you need to re-download cached gems
45+
working-directory: "${{ github.workspace }}/docs"
46+
- name: Setup Pages
47+
id: pages
48+
uses: actions/configure-pages@v3
49+
- name: Build with Jekyll
50+
# Outputs to the './_site' directory by default
51+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
52+
env:
53+
JEKYLL_ENV: production
54+
- name: Upload artifact
55+
# Automatically uploads an artifact from the './_site' directory by default
56+
uses: actions/upload-pages-artifact@v1
57+
with:
58+
path: "docs/_site/"
59+
60+
# Deployment job
61+
deploy:
62+
environment:
63+
name: github-pages
64+
url: ${{ steps.deployment.outputs.page_url }}
65+
runs-on: ubuntu-latest
66+
needs: build
67+
steps:
68+
- name: Deploy to GitHub Pages
69+
id: deployment
70+
uses: actions/deploy-pages@v2
71+

‎docs/Gemfile

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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.7.0" # pinned to the current release
7+
# gem "just-the-docs" # always download the latest release
8+
9+
# gem "jekyll-default-layout"
10+

‎docs/Gemfile.lock

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.6)
5+
public_suffix (>= 2.0.2, < 6.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.2.2)
8+
em-websocket (0.5.3)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0)
11+
eventmachine (1.2.7)
12+
ffi (1.16.3)
13+
forwardable-extended (2.6.0)
14+
google-protobuf (3.25.1-arm64-darwin)
15+
google-protobuf (3.25.1-x86_64-linux)
16+
http_parser.rb (0.8.0)
17+
i18n (1.14.1)
18+
concurrent-ruby (~> 1.0)
19+
jekyll (4.3.3)
20+
addressable (~> 2.4)
21+
colorator (~> 1.0)
22+
em-websocket (~> 0.5)
23+
i18n (~> 1.0)
24+
jekyll-sass-converter (>= 2.0, < 4.0)
25+
jekyll-watch (~> 2.0)
26+
kramdown (~> 2.3, >= 2.3.1)
27+
kramdown-parser-gfm (~> 1.0)
28+
liquid (~> 4.0)
29+
mercenary (>= 0.3.6, < 0.5)
30+
pathutil (~> 0.9)
31+
rouge (>= 3.0, < 5.0)
32+
safe_yaml (~> 1.0)
33+
terminal-table (>= 1.8, < 4.0)
34+
webrick (~> 1.7)
35+
jekyll-include-cache (0.2.1)
36+
jekyll (>= 3.7, < 5.0)
37+
jekyll-sass-converter (3.0.0)
38+
sass-embedded (~> 1.54)
39+
jekyll-seo-tag (2.8.0)
40+
jekyll (>= 3.8, < 5.0)
41+
jekyll-watch (2.2.1)
42+
listen (~> 3.0)
43+
just-the-docs (0.7.0)
44+
jekyll (>= 3.8.5)
45+
jekyll-include-cache
46+
jekyll-seo-tag (>= 2.0)
47+
rake (>= 12.3.1)
48+
kramdown (2.4.0)
49+
rexml
50+
kramdown-parser-gfm (1.1.0)
51+
kramdown (~> 2.0)
52+
liquid (4.0.4)
53+
listen (3.8.0)
54+
rb-fsevent (~> 0.10, >= 0.10.3)
55+
rb-inotify (~> 0.9, >= 0.9.10)
56+
mercenary (0.4.0)
57+
pathutil (0.16.2)
58+
forwardable-extended (~> 2.6)
59+
public_suffix (5.0.4)
60+
rake (13.0.6)
61+
rb-fsevent (0.11.2)
62+
rb-inotify (0.10.1)
63+
ffi (~> 1.0)
64+
rexml (3.2.6)
65+
rouge (4.2.0)
66+
safe_yaml (1.0.5)
67+
sass-embedded (1.69.5-arm64-darwin)
68+
google-protobuf (~> 3.23)
69+
sass-embedded (1.69.5-x86_64-linux-gnu)
70+
google-protobuf (~> 3.23)
71+
terminal-table (3.0.2)
72+
unicode-display_width (>= 1.1.1, < 3)
73+
unicode-display_width (2.5.0)
74+
webrick (1.8.1)
75+
76+
PLATFORMS
77+
arm64-darwin-23
78+
x86_64-linux
79+
80+
DEPENDENCIES
81+
jekyll (~> 4.3.3)
82+
just-the-docs (= 0.7.0)
83+
84+
BUNDLED WITH
85+
2.3.26

‎docs/_config.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
title: RDF Maven Plugins
2+
#remote_theme: pmarsceill/just-the-docs
3+
theme: just-the-docs
4+
url: https://scaseco.github.io
5+
6+
# plugins:
7+
# - jekyll-default-layout
8+
9+
#search_enabled: true
10+
# logo: "assets/images/sansa-logo-blue.png"
11+
#markdown: kramdown
12+
#kramdown:
13+
# parse_block_html: true
14+
15+
16+
#exclude:
17+
# - sansa*
18+
# - javadoc
19+
# - scaladocs
20+
21+
# Aux links for the upper right navigation
22+
aux_links:
23+
"Scaseco":
24+
- "https://scaseco.github.io/"
25+
26+
# Footer last edited timestamp
27+
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
28+
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
29+
30+
# Footer "Edit this page on GitHub" link text
31+
gh_edit_link: true # show or hide edit this page link
32+
gh_edit_link_text: "Edit this page on GitHub."
33+
gh_edit_repository: "https://github.com/Scaseco/rpt-maven-plugin" # the github URL for your repo
34+
gh_edit_branch: "develop" # the branch that your docs is served from
35+
gh_edit_source: "docs" # the source that your files originate from
36+
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
37+

‎docs/index.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: default
3+
title: Overview
4+
nav_order: 10
5+
---
6+
7+
# Maven RDF Plugins
8+

0 commit comments

Comments
 (0)