Skip to content

Commit 26fd455

Browse files
ManuelSchneid3rManuelSchneid3r
committed
new jtd site
1 parent 31aca4a commit 26fd455

File tree

198 files changed

+1222
-2479
lines changed

Some content is hidden

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

198 files changed

+1222
-2479
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,36 +13,63 @@ jobs:
1313
runs-on: ubuntu-latest
1414
steps:
1515

16-
- name: Checkout source code
17-
uses: actions/checkout@v3
16+
- uses: actions/checkout@v3
1817
with:
1918
submodules: recursive
2019

21-
- name: Fetch the albert repo
22-
run: git clone --recursive --depth 1 https://github.com/albertlauncher/albert.git
20+
- run: git clone --depth 1 https://github.com/albertlauncher/albert.git
2321

24-
- name: Run doxygen
25-
uses: mattnotmitt/[email protected]
22+
- uses: mattnotmitt/[email protected]
2623

27-
- name: Build site
28-
uses: actions/jekyll-build-pages@v1
24+
- run: find .
25+
26+
# - run: make build
27+
28+
- uses: ruby/setup-ruby@v1
2929
with:
30-
source: "src"
31-
destination: "src/_site"
30+
ruby-version: '3.3' # Not needed with a `.ruby-version` or `.tool-versions`
31+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
32+
working-directory: ./src
33+
34+
#- run: gem install bundler
35+
36+
#- run: bundle install
37+
38+
- run: cd src && JEKYLL_ENV=production bundle exec jekyll build
3239

3340
- run: find .
41+
42+
# - uses: ruby/setup-ruby@v1
43+
# with:
44+
# ruby-version: '3.3'
45+
# bundler-cache: true
46+
#
47+
# - run: bundle install
48+
#
49+
# - name: Build site
50+
# uses: actions/jekyll-build-pages@v1
51+
# with:
52+
# source: "src"
53+
# destination: "src/_site"
3454

3555
- name: Deploy
36-
run: |
37-
sudo chown -R runner:docker .
38-
mv html src/_site/reference
39-
cd src/_site
40-
git init
41-
git config --local user.email "[email protected]"
42-
git config --local user.name "GitHub Action"
43-
git add .
44-
git commit -m "Auto-commit from GitHub Action"
45-
git remote add origin "https://${{ secrets.PAT }}@github.com/albertlauncher/albertlauncher.github.io"
46-
git branch -M master
47-
git push --force origin master
56+
uses: peaceiris/actions-gh-pages@v4
57+
with:
58+
personal_token: ${{ secrets.PAT }}
59+
external_repository: albertlauncher/albertlauncher.github.io
60+
publish_branch: master
61+
publish_dir: ./src/_site
62+
63+
# - name: Deploy
64+
# run: |
65+
# sudo chown -R runner:docker .
66+
# cd src/_site
67+
# git init
68+
# git config --local user.email "[email protected]"
69+
# git config --local user.name "GitHub Action"
70+
# git add .
71+
# git commit -m "Auto-commit from GitHub Action"
72+
# git remote add origin "https://${{ secrets.PAT }}@github.com/albertlauncher/albertlauncher.github.io"
73+
# git branch -M master
74+
# git push --force origin master
4875

‎Dockerfile‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
FROM ruby:3-slim
2+
3+
WORKDIR /srv/jekyll
4+
COPY src/Gemfile .
5+
EXPOSE 4000
6+
7+
ARG DEBIAN_FRONTEND=noninteractive
8+
RUN apt-get update \
9+
&& apt-get -y install build-essential \
10+
&& bundle install \
11+
&& apt-get -y clean \
12+
&& apt-get -y purge build-essential \
13+
&& apt-get -y autoremove \
14+
&& rm -rf /var/lib/apt/lists/*

‎Doxyfile‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,24 @@ DOT_IMAGE_FORMAT = svg
1313
DOXYFILE_ENCODING = UTF-8
1414
EXTRACT_ALL = YES
1515
GENERATE_LATEX = NO
16-
INPUT = albert/include albert/plugins/README.md
16+
INPUT = albert/include
17+
18+
1719
JAVADOC_AUTOBRIEF = YES
1820
LAYOUT_FILE = DoxygenLayout.xml
21+
22+
# Hide ALBERT_EXPORT
23+
ENABLE_PREPROCESSING = YES
24+
MACRO_EXPANSION = YES
25+
EXPAND_ONLY_PREDEF = YES
1926
PREDEFINED = ALBERT_PLUGIN_ID
27+
PREDEFINED = ALBERT_EXPORT=
28+
2029
PROJECT_LOGO = "src/img/albert.svg"
2130
PROJECT_NAME = "Albert"
2231
QT_AUTOBRIEF = YES
2332
RECURSIVE = YES
24-
USE_MDFILE_AS_MAINPAGE = "albert/plugins/README.md"
33+
#USE_MDFILE_AS_MAINPAGE = "albert/plugins/README.md"
2534

2635
# BASE THEME
2736
#GENERATE_TREEVIEW = YES # optional. Also works without treeview
@@ -36,3 +45,4 @@ DISABLE_INDEX = NO
3645
FULL_SIDEBAR = NO
3746
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css doxygen-awesome-css/doxygen-awesome-sidebar-only.css
3847
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5
48+
HTML_OUTPUT = src/reference

‎DoxygenLayout.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- Generated by doxygen 1.9.7 -->
33
<!-- Navigation index tabs for HTML output -->
44
<navindex>
5-
<tab type="mainpage" visible="yes" title=""/>
5+
<tab type="mainpage" visible="no" title=""/>
66
<tab type="pages" visible="yes" title="" intro=""/>
77
<tab type="modules" visible="yes" title="" intro=""/>
88
<tab type="namespaces" visible="yes" title="">

‎Makefile‎

Lines changed: 24 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,24 @@
1-
#all: doxygen jekyll-build jekyll-deploy
2-
#
3-
#release: all
4-
#
5-
#doxygen:
6-
# rm -rf albert
7-
# git clone --depth 1 https://github.com/albertlauncher/albert.git
8-
# doxygen
9-
# rm -rf src/reference
10-
# mv albert/output/html src/reference
11-
#
12-
#jekyll-build:
13-
# docker run -t --rm -v "$(shell pwd)/src:/srv/jekyll" jekyll/jekyll jekyll build
14-
#
15-
#jekyll-serve:
16-
# docker run -t --rm -v "$(shell pwd)/src:/srv/jekyll" -p "4000:4000" jekyll/jekyll jekyll serve --host 0.0.0.0
17-
#
18-
#jekyll-check:
19-
# docker run -t --rm -v "$(shell pwd)/src/_site:/src" klakegg/html-proofer:3.17.0 --allow-hash-href --check-html --empty-alt-ignore || true
20-
#
21-
#jekyll-deploy:
22-
# git -C ./src/_site init
23-
# git -C ./src/_site add .
24-
# git -C ./src/_site commit -m "Build `date`"
25-
# git -C ./src/_site push --force "https://github.com/albertlauncher/albertlauncher.github.io.git" master
26-
#
27-
#clean:
28-
# rm -rf output albert
29-
#
30-
#
31-
#
32-
#.PHONY: doxygen
1+
info:
2+
less Makefile
3+
4+
doxygen:
5+
rm -rf albert src/reference
6+
git clone --depth 1 https://github.com/albertlauncher/albert.git
7+
doxygen
8+
9+
build:
10+
docker-compose up jekyll-build
11+
12+
serve:
13+
docker-compose up jekyll-serve
14+
15+
html-proofer:
16+
docker-compose up html-proofer
17+
18+
deploy: doxygen html-proofer build
19+
git -C ./src/_site init
20+
git -C ./src/_site add .
21+
git -C ./src/_site commit -m "Build `date`"
22+
git -C ./src/_site push --force "https://github.com/albertlauncher/albertlauncher.github.io.git" master
23+
24+
.PHONY: doxygen

‎docker-compose.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
version: "3.5"
2+
3+
services:
4+
5+
jekyll: &jekyll
6+
build:
7+
dockerfile: Dockerfile
8+
image: jekyll
9+
volumes:
10+
- ./src:/srv/jekyll
11+
stdin_open: true
12+
tty: true
13+
entrypoint: bundle exec jekyll
14+
command: --version
15+
16+
jekyll-build:
17+
<<: *jekyll
18+
command: build
19+
20+
jekyll-serve:
21+
<<: *jekyll
22+
ports:
23+
- 4000:4000
24+
command: serve --host 0.0.0.0 --trace
25+
26+
html-proofer:
27+
image: klakegg/html-proofer:3.17.0
28+
volumes:
29+
- ./src/_site:/src
30+
command: --allow-hash-href --check-html --empty-alt-ignore
31+

‎doxygen-awesome-css‎

‎src/404.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
layout: page
32
title: Oops…
3+
nav_exclude: true
44
---
55

66
Nothing found here. Visit [home](/)

‎src/Gemfile‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,8 @@ source "https://rubygems.org"
44

55
gem "jekyll"
66
gem "webrick"
7-
gem 'jekyll-spaceship'
8-
gem "jekyll-sass-converter", "~> 2.0"
7+
gem "just-the-docs"
8+
9+
#gem "jekyll-default-layout"
10+
#gem 'jekyll-spaceship'
11+
#gem "jekyll-sass-converter", "~> 2.0"

‎src/_config.yml‎

Lines changed: 79 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,86 @@
1+
2+
3+
# https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
4+
15
title: Albert
2-
email: [email protected]
6+
37
description: > # this means to ignore newlines until "baseurl:"
48
Albert is a unified and efficient access to your machine. Technically it is a keyboard launcher
59
written in C++/Qt. The plugin based architecture makes it extremely flexible and powerful. Plugins
610
can be used to create frontends or functional extensions. Extensions can also be implemented
711
using embedded Python modules or via a CGI approach in any language you want.
12+
813
baseurl: "" # the subpath of your site, e.g. /blog
9-
url: https://albertlauncher.github.io
10-
github_username: manuelschneid3r
11-
repository: https://github.com/albertlauncher
12-
exclude: [vendor]
13-
future: true
14-
15-
collections:
16-
pages:
17-
output: true
18-
19-
plugins:
20-
- jekyll-spaceship
14+
url: "https://albertlauncher.github.io"
15+
repository: "https://github.com/albertlauncher"
16+
17+
theme: just-the-docs
18+
color_scheme: custom
19+
20+
defaults:
21+
-
22+
scope:
23+
path: "" # an empty string here means all files in the project
24+
values:
25+
layout: "page"
26+
27+
favicon_ico: "/img/favicon.ico"
28+
#aux_links:
29+
# Albert on GitHub:
30+
# - "https://github.com/albertlauncher/albert"
31+
#aux_links_new_tab: true
32+
last_edit_timestamp: true
33+
heading_anchors: true
34+
35+
enable_copy_code_button: true
36+
37+
permalink: pretty # no html extension
38+
39+
nav_external_links:
40+
- title: API reference
41+
url: /reference/namespacealbert.html
42+
- title: GitHub
43+
url: https://github.com/albertlauncher/albert
44+
45+
callouts:
46+
callout-blue:
47+
color: blue
48+
callout-yellow:
49+
color: yellow
50+
callout-red:
51+
color: red
52+
note:
53+
title: Note
54+
color: blue
55+
warning:
56+
title: Warning
57+
color: yellow
58+
59+
## Footer "Edit this page on GitHub" link text
60+
gh_edit_link: true # show or hide edit this page link
61+
gh_edit_link_text: "Edit this page on GitHub"
62+
gh_edit_repository: "https://github.com/albertlauncher/documentation" # the github URL for your repo
63+
gh_edit_source: src # the source that your files originate from
64+
gh_edit_branch: "master" # the branch that your docs is served from
65+
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
66+
67+
mermaid:
68+
# Version of mermaid library
69+
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
70+
version: "9.1.3"
71+
#
72+
73+
#email: [email protected]
74+
#github_username: manuelschneid3r
75+
#exclude: [vendor]
76+
#future: true
77+
78+
79+
80+
81+
82+
#plugins:
83+
#- jekyll-spaceship
84+
# - jekyll-default-layout
85+
86+

0 commit comments

Comments
 (0)