init

.github/workflows/jekyll-publish.yml

@@ -0,0 +1,66 @@
+name: Publish jekyll on Pages
+
+on:
+  workflow_call:
+    inputs:
+      working-directory:
+        description: 'The working directory where the Jekyll site is located'
+        default: docs
+        type: string
+      publish:
+        description: 'Publish the site to GitHub Pages'
+        required: true
+        default: false
+        type: boolean
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ${{ inputs.working-directory}}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@5f19ec79cedfadb78ab837f95b87734d0003c899 # v1.173.0
+        with:
+          working-directory: ${{ inputs.working-directory}}
+          bundler-cache: true
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
+
+      - name: Build with Jekyll
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        if: ${{ inputs.publish }}
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
+        with:
+          path: "${{ inputs.working-directory}}/_site/"
+
+  deploy:
+    runs-on: ubuntu-latest
+    if: ${{ inputs.publish }}
+    concurrency:
+      group: "pages"
+      cancel-in-progress: true
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

.github/workflows/test.yml

@@ -0,0 +1,11 @@
+name: Test workflow
+
+on:
+  push:
+
+jobs:
+  test:
+    uses: ./.github/workflows/jekyll-publish.yml
+    with:
+      working-directory: docs
+      publish: ${{ github.event_name == 'push' && github.ref_name == 'init'}}

docs/.ruby-version

@@ -0,0 +1 @@
+3.1.4

docs/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "jekyll", "~> 4.3.3" # installed by `gem jekyll`
+# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
+
+gem "just-the-docs", "0.8.1" # pinned to the current release
+# gem "just-the-docs"        # always download the latest release

docs/Gemfile.lock

@@ -0,0 +1,89 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.2.2)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.16.3)
+    forwardable-extended (2.6.0)
+    google-protobuf (3.25.1-arm64-darwin)
+    google-protobuf (3.25.1-x86_64-darwin)
+    google-protobuf (3.25.1-x86_64-linux)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    just-the-docs (0.8.1)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (5.0.4)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.6)
+    rouge (4.2.0)
+    safe_yaml (1.0.5)
+    sass-embedded (1.69.5-arm64-darwin)
+      google-protobuf (~> 3.23)
+    sass-embedded (1.69.5-x86_64-darwin)
+      google-protobuf (~> 3.23)
+    sass-embedded (1.69.5-x86_64-linux-gnu)
+      google-protobuf (~> 3.23)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  arm64-darwin-23
+  x86_64-darwin-23
+  x86_64-linux
+
+DEPENDENCIES
+  jekyll (~> 4.3.3)
+  just-the-docs (= 0.8.1)
+
+BUNDLED WITH
+   2.3.26

docs/_config.yml

@@ -0,0 +1,29 @@
+title: Alfresco Jekyll Build tools
+description: Documentation generator
+theme: just-the-docs
+color_scheme: alfresco
+
+url: https://alfresco.github.io/jekyll-build-tools
+
+aux_links:
+  Docs: https://docs.alfresco.com/
+  GitHub Repository: https://github.com/Alfresco/jekyll-build-tools
+
+aux_links_new_tab: true
+
+gh_edit_link: true
+gh_edit_link_text: "Improve this page on GitHub"
+gh_edit_repository: https://github.com/Alfresco/jekyll-build-tools
+gh_edit_branch: master
+gh_edit_source: docs
+gh_edit_view_mode: edit
+
+logo: "resources/hyland-alfresco-logos.png"
+favicon_ico: "favicon.ico"
+
+defaults:
+  # apply the default layout to all markdown pages
+  - scope:
+      path: "*.md"
+    values:
+      layout: "default"

docs/_includes/head_custom.html

@@ -0,0 +1,3 @@
+<style>
+    @import url('https://fonts.googleapis.com/css2?family=Inter:[email protected]&display=swap')
+</style>

docs/_sass/color_schemes/alfresco.scss

@@ -0,0 +1,9 @@
+$link-color: #3273dc;
+$body-font-family: "Inter", sans-serif;
+
+$font-size-5: 0.88rem;
+
+.main-content {
+    color: #212328;
+    font-weight: 300;
+}

docs/index.md

@@ -0,0 +1,26 @@
+---
+title: Home
+layout: home
+nav_order: 1
+---
+
+# Your cool project
+
+This project serve as a template for documentation websites.
+
+## Documentation
+
+Explain here how to use your project.
+
+## Development
+
+Explain here guidelines for developing the project.
+
+## License
+
+The code in this repository is released under the Apache License, see the
+[LICENSE](https://github.com/Alfresco/jekyll-build-tools/blob/master/LICENSE) file for details.
+
+## Contribution
+
+Explain here guidelines for contributing to this project.