new jtd site

.github/workflows/deploy.yml

@@ -13,36 +13,63 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - name: Checkout source code
-      uses: actions/checkout@v3
+    - uses: actions/checkout@v3
       with:
         submodules: recursive
 
-    - name: Fetch the albert repo
-      run: git clone --recursive --depth 1 https://github.com/albertlauncher/albert.git
+    - run: git clone --depth 1 https://github.com/albertlauncher/albert.git
 
-    - name: Run doxygen
-      uses: mattnotmitt/[email protected]
+    - uses: mattnotmitt/[email protected]
 
-    - name: Build site
-      uses: actions/jekyll-build-pages@v1
+    - run: find .
+
+#    - run: make build
+
+    - uses: ruby/setup-ruby@v1
       with:
-        source: "src"
-        destination: "src/_site"
+        ruby-version: '3.3' # Not needed with a `.ruby-version` or `.tool-versions`
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        working-directory: ./src
+
+    #- run: gem install bundler
+
+    #- run: bundle install
+
+    - run: cd src && JEKYLL_ENV=production bundle exec jekyll build
 
     - run: find .
+
+#    - uses: ruby/setup-ruby@v1
+#      with:
+#        ruby-version: '3.3'
+#        bundler-cache: true
+#
+#    - run: bundle install
+#
+#    - name: Build site
+#      uses: actions/jekyll-build-pages@v1
+#      with:
+#        source: "src"
+#        destination: "src/_site"
 
     - name: Deploy
-      run: |
-        sudo chown -R runner:docker .
-        mv html src/_site/reference
-        cd src/_site
-        git init
-        git config --local user.email "[email protected]"
-        git config --local user.name "GitHub Action"
-        git add .
-        git commit -m "Auto-commit from GitHub Action"
-        git remote add origin "https://${{ secrets.PAT }}@github.com/albertlauncher/albertlauncher.github.io"
-        git branch -M master
-        git push --force origin master
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        personal_token: ${{ secrets.PAT }}
+        external_repository: albertlauncher/albertlauncher.github.io
+        publish_branch: master
+        publish_dir: ./src/_site
+
+   # - name: Deploy
+   #   run: |
+   #     sudo chown -R runner:docker .
+   #     cd src/_site
+   #     git init
+   #     git config --local user.email "[email protected]"
+   #     git config --local user.name "GitHub Action"
+   #     git add .
+   #     git commit -m "Auto-commit from GitHub Action"
+   #     git remote add origin "https://${{ secrets.PAT }}@github.com/albertlauncher/albertlauncher.github.io"
+   #     git branch -M master
+   #     git push --force origin master
 

Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:3-slim
+
+WORKDIR /srv/jekyll
+COPY src/Gemfile .
+EXPOSE 4000
+
+ARG DEBIAN_FRONTEND=noninteractive
+RUN apt-get update \
+    && apt-get -y install build-essential \
+    && bundle install \
+    && apt-get -y clean \
+    && apt-get -y purge build-essential \
+    && apt-get -y autoremove \
+    && rm -rf /var/lib/apt/lists/*

Doxyfile

@@ -13,15 +13,24 @@ DOT_IMAGE_FORMAT       = svg
 DOXYFILE_ENCODING      = UTF-8
 EXTRACT_ALL            = YES
 GENERATE_LATEX         = NO
-INPUT                  = albert/include albert/plugins/README.md
+INPUT                  = albert/include
+
+
 JAVADOC_AUTOBRIEF      = YES
 LAYOUT_FILE            = DoxygenLayout.xml
+
+# Hide ALBERT_EXPORT
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
 PREDEFINED             = ALBERT_PLUGIN_ID
+PREDEFINED             = ALBERT_EXPORT=
+
 PROJECT_LOGO           = "src/img/albert.svg"
 PROJECT_NAME           = "Albert"
 QT_AUTOBRIEF           = YES
 RECURSIVE              = YES
-USE_MDFILE_AS_MAINPAGE = "albert/plugins/README.md"
+#USE_MDFILE_AS_MAINPAGE = "albert/plugins/README.md"
 
 # BASE THEME
 #GENERATE_TREEVIEW      = YES # optional. Also works without treeview
@@ -36,3 +45,4 @@ DISABLE_INDEX          = NO
 FULL_SIDEBAR           = NO
 HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css doxygen-awesome-css/doxygen-awesome-sidebar-only.css
 HTML_COLORSTYLE        = LIGHT # required with Doxygen >= 1.9.5
+HTML_OUTPUT            = src/reference

DoxygenLayout.xml

@@ -2,7 +2,7 @@
   <!-- Generated by doxygen 1.9.7 -->
   <!-- Navigation index tabs for HTML output -->
   <navindex>
-    <tab type="mainpage" visible="yes" title=""/>
+    <tab type="mainpage" visible="no" title=""/>
     <tab type="pages" visible="yes" title="" intro=""/>
     <tab type="modules" visible="yes" title="" intro=""/>
     <tab type="namespaces" visible="yes" title="">

Makefile

@@ -1,32 +1,24 @@
-#all: doxygen jekyll-build jekyll-deploy
-#
-#release: all
-#
-#doxygen:
-#	rm -rf albert
-#	git clone --depth 1 https://github.com/albertlauncher/albert.git
-#	doxygen
-#	rm -rf src/reference
-#	mv albert/output/html src/reference
-#
-#jekyll-build:
-#	docker run -t --rm -v "$(shell pwd)/src:/srv/jekyll" jekyll/jekyll jekyll build
-#
-#jekyll-serve:
-#	docker run -t --rm -v "$(shell pwd)/src:/srv/jekyll" -p "4000:4000" jekyll/jekyll jekyll serve --host 0.0.0.0
-#
-#jekyll-check:
-#	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
-#
-#jekyll-deploy:
-#	git -C ./src/_site init
-#	git -C ./src/_site add .
-#	git -C ./src/_site commit -m "Build `date`"
-#	git -C ./src/_site push --force "https://github.com/albertlauncher/albertlauncher.github.io.git" master
-#
-#clean:
-#	rm -rf output albert
-#
-#
-#
-#.PHONY: doxygen
+info:
+	less Makefile
+
+doxygen:
+	rm -rf albert src/reference
+	git clone --depth 1 https://github.com/albertlauncher/albert.git
+	doxygen
+
+build:
+	docker-compose up jekyll-build
+
+serve:
+	docker-compose up jekyll-serve
+
+html-proofer:
+	docker-compose up html-proofer
+
+deploy: doxygen html-proofer build
+	git -C ./src/_site init
+	git -C ./src/_site add .
+	git -C ./src/_site commit -m "Build `date`"
+	git -C ./src/_site push --force "https://github.com/albertlauncher/albertlauncher.github.io.git" master
+
+.PHONY: doxygen

docker-compose.yml

@@ -0,0 +1,31 @@
+version: "3.5"
+
+services:
+
+  jekyll: &jekyll
+    build:
+      dockerfile: Dockerfile
+    image: jekyll
+    volumes:
+      - ./src:/srv/jekyll
+    stdin_open: true
+    tty: true
+    entrypoint: bundle exec jekyll
+    command: --version
+
+  jekyll-build:
+    <<: *jekyll
+    command: build
+
+  jekyll-serve:
+    <<: *jekyll
+    ports:
+      - 4000:4000
+    command: serve --host 0.0.0.0 --trace
+
+  html-proofer:
+    image: klakegg/html-proofer:3.17.0
+    volumes:
+      - ./src/_site:/src
+    command: --allow-hash-href --check-html --empty-alt-ignore
+

src/404.md

@@ -1,6 +1,6 @@
 ---
-layout: page
 title: Oops…
+nav_exclude: true
 ---
 
 Nothing found here. Visit [home](/)

src/Gemfile

@@ -4,5 +4,8 @@ source "https://rubygems.org"
 
 gem "jekyll"
 gem "webrick"
-gem 'jekyll-spaceship'
-gem "jekyll-sass-converter", "~> 2.0"
+gem "just-the-docs"
+
+#gem "jekyll-default-layout"
+#gem 'jekyll-spaceship'
+#gem "jekyll-sass-converter", "~> 2.0"

src/_config.yml

@@ -1,20 +1,86 @@
+
+
+# https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
+
 title: Albert
-email: [email protected]
+
 description: > # this means to ignore newlines until "baseurl:"
   Albert is a unified and efficient access to your machine. Technically it is a keyboard launcher
   written in C++/Qt. The plugin based architecture makes it extremely flexible and powerful. Plugins
   can be used to create frontends or functional extensions. Extensions can also be implemented
   using embedded Python modules or via a CGI approach in any language you want.
+
 baseurl: "" # the subpath of your site, e.g. /blog
-url: https://albertlauncher.github.io
-github_username:  manuelschneid3r
-repository: https://github.com/albertlauncher
-exclude: [vendor]
-future: true
-
-collections:
-  pages:
-    output: true
-
-plugins:
-  - jekyll-spaceship
+url: "https://albertlauncher.github.io"
+repository: "https://github.com/albertlauncher"
+
+theme: just-the-docs
+color_scheme: custom
+
+defaults:
+  -
+    scope:
+      path: "" # an empty string here means all files in the project
+    values:
+      layout: "page"
+
+favicon_ico: "/img/favicon.ico"
+#aux_links:
+#  Albert on GitHub:
+#    - "https://github.com/albertlauncher/albert"
+#aux_links_new_tab: true
+last_edit_timestamp: true
+heading_anchors: true
+
+enable_copy_code_button: true
+
+permalink: pretty  # no html extension
+
+nav_external_links:
+  - title: API reference
+    url: /reference/namespacealbert.html
+  - title: GitHub
+    url: https://github.com/albertlauncher/albert
+
+callouts:
+  callout-blue:
+    color: blue
+  callout-yellow:
+    color: yellow
+  callout-red:
+    color: red
+  note:
+    title: Note
+    color: blue
+  warning:
+    title: Warning
+    color: yellow
+
+## Footer "Edit this page on GitHub" link text
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/albertlauncher/documentation" # the github URL for your repo
+gh_edit_source: src # the source that your files originate from
+gh_edit_branch: "master" # the branch that your docs is served from
+gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+mermaid:
+  # Version of mermaid library
+  # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
+  version: "9.1.3"
+  #
+
+#email: [email protected]
+#github_username:  manuelschneid3r
+#exclude: [vendor]
+#future: true
+
+
+
+
+
+#plugins:
+  #- jekyll-spaceship
+  #  - jekyll-default-layout
+
+

src/_drafts/date-albert-version-released.md

@@ -1,5 +1,4 @@
 ---
-layout: page
 title:  "Albert __version__ released"
 date: __YAML_DATE__
 ---