Skip to content
This repository was archived by the owner on Feb 16, 2025. It is now read-only.

Commit 2fab782

Browse files
ryanabxryanabx
committed
docs: add docs
1 parent e9fefc4 commit 2fab782

File tree

7 files changed

+221
-0
lines changed

7 files changed

+221
-0
lines changed

Diff for: ‎.github/workflows/pages.yml

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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: ["master"]
12+
paths:
13+
- "docs/**"
14+
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.3' # 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

Diff for: ‎docs/.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Not sure what a .gitignore is?
2+
# See: https://git-scm.com/docs/gitignore
3+
4+
# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
5+
# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
6+
7+
# Ignore the default location of the built site, and caches and metadata generated by Jekyll
8+
_site/
9+
.sass-cache/
10+
.jekyll-cache/
11+
.jekyll-metadata
12+
13+
# Ignore folders generated by Bundler
14+
.bundle/
15+
vendor/

Diff for: ‎docs/Gemfile

+7
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.2" # pinned to the current release
7+
# gem "just-the-docs" # always download the latest release

Diff for: ‎docs/Gemfile.lock

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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.3)
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 (4.26.1)
15+
rake (>= 13)
16+
google-protobuf (4.26.1-arm64-darwin)
17+
rake (>= 13)
18+
google-protobuf (4.26.1-x86_64-linux)
19+
rake (>= 13)
20+
http_parser.rb (0.8.0)
21+
i18n (1.14.4)
22+
concurrent-ruby (~> 1.0)
23+
jekyll (4.3.3)
24+
addressable (~> 2.4)
25+
colorator (~> 1.0)
26+
em-websocket (~> 0.5)
27+
i18n (~> 1.0)
28+
jekyll-sass-converter (>= 2.0, < 4.0)
29+
jekyll-watch (~> 2.0)
30+
kramdown (~> 2.3, >= 2.3.1)
31+
kramdown-parser-gfm (~> 1.0)
32+
liquid (~> 4.0)
33+
mercenary (>= 0.3.6, < 0.5)
34+
pathutil (~> 0.9)
35+
rouge (>= 3.0, < 5.0)
36+
safe_yaml (~> 1.0)
37+
terminal-table (>= 1.8, < 4.0)
38+
webrick (~> 1.7)
39+
jekyll-include-cache (0.2.1)
40+
jekyll (>= 3.7, < 5.0)
41+
jekyll-sass-converter (3.0.0)
42+
sass-embedded (~> 1.54)
43+
jekyll-seo-tag (2.8.0)
44+
jekyll (>= 3.8, < 5.0)
45+
jekyll-watch (2.2.1)
46+
listen (~> 3.0)
47+
just-the-docs (0.8.2)
48+
jekyll (>= 3.8.5)
49+
jekyll-include-cache
50+
jekyll-seo-tag (>= 2.0)
51+
rake (>= 12.3.1)
52+
kramdown (2.4.0)
53+
rexml
54+
kramdown-parser-gfm (1.1.0)
55+
kramdown (~> 2.0)
56+
liquid (4.0.4)
57+
listen (3.9.0)
58+
rb-fsevent (~> 0.10, >= 0.10.3)
59+
rb-inotify (~> 0.9, >= 0.9.10)
60+
mercenary (0.4.0)
61+
pathutil (0.16.2)
62+
forwardable-extended (~> 2.6)
63+
public_suffix (5.0.5)
64+
rake (13.2.1)
65+
rb-fsevent (0.11.2)
66+
rb-inotify (0.10.1)
67+
ffi (~> 1.0)
68+
rexml (3.2.6)
69+
rouge (4.2.1)
70+
safe_yaml (1.0.5)
71+
sass-embedded (1.75.0)
72+
google-protobuf (>= 3.25, < 5.0)
73+
rake (>= 13.0.0)
74+
sass-embedded (1.75.0-arm64-darwin)
75+
google-protobuf (>= 3.25, < 5.0)
76+
sass-embedded (1.75.0-x86_64-linux-gnu)
77+
google-protobuf (>= 3.25, < 5.0)
78+
terminal-table (3.0.2)
79+
unicode-display_width (>= 1.1.1, < 3)
80+
unicode-display_width (2.5.0)
81+
webrick (1.8.1)
82+
83+
PLATFORMS
84+
arm64-darwin
85+
x86_64-linux-gnu
86+
87+
DEPENDENCIES
88+
jekyll (~> 4.3.3)
89+
just-the-docs (= 0.8.2)
90+
91+
BUNDLED WITH
92+
2.5.9

Diff for: ‎docs/LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 just-the-docs
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: ‎docs/_config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
title: Container Desktop Entries Docs
2+
description: Documentation for Container Desktop Entries
3+
theme: just-the-docs
4+
5+
url: https://ryanabx.github.io/container-desktop-entries/
6+
7+
aux_links:
8+
Repo: https://github.com/ryanabx/container-desktop-entries

Diff for: ‎docs/index.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Home
3+
layout: home
4+
---
5+
6+
# Container Desktop Entries
7+
8+
`container-desktop-entries` lets you add desktop entries for all the applications in your containers! It supports a myriad of configurations and just works (tm).

0 commit comments

Comments
 (0)