Skip to content

Commit

Permalink
Create jekyll-gh-pages.yml and use just-the-docs in GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Ircama committed Nov 7, 2024
1 parent c7145cd commit 61b208e
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 1 deletion.
51 changes: 51 additions & 0 deletions .github/workflows/jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll with GitHub Pages dependencies preinstalled

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./
destination: ./_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
66 changes: 66 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
remote_theme: bmndc/just-the-docs
search_enabled: false
enable_copy_code_button: true
heading_anchors: true
aux_links:
"epson_print_conf on GitHub":
- "https://github.com/Ircama/epson_print_conf/"
aux_links_new_tab: true
nav_enabled: false

# Table of Contents
# Enable or disable the Table of Contents globally
# Supports true (default) or false
toc_enabled: true
toc:
# Minimum header level to include in ToC
# Default: 1
min_level: 1
# Maximum header level to include in ToC
# Default: 6
max_level: 6
# Display the ToC as ordered list instead of an unordered list
# Supports true (default) or false
ordered: true
# Whether ToC will be a single level list
# Supports true or false (default)
flat_toc: false

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

footer_content: 'Copyright &copy; 2023-2024 Ircama. Distributed by an <a href="https://raw.githubusercontent.com/Ircama/epson_print_conf/refs/heads/main/LICENSE">MIT license.</a>'

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
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

# 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/Ircama/epson_print_conf" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

plugins:
- jekyll-autolinker
- jekyll-remote-theme # Add if not already present
- jekyll-include-cache # Optional, for caching


kramdown:
syntax_highlighter_opts:
block:
line_numbers: false

compress_html:
clippings: all
comments: all
endings: all
startings: []
blanklines: false
profile: false
# ignore:

2 changes: 1 addition & 1 deletion ui.py
Original file line number Diff line number Diff line change
Expand Up @@ -1023,7 +1023,7 @@ def clear_printer_list(self):

def open_help_browser(self):
# Opens a web browser to a help URL
url = "https://github.com/Ircama/epson_print_conf/?tab=readme-ov-file#epson_print_conf"
url = "https://ircama.github.io/epson_print_conf"
self.show_status_text_view()
try:
ret = webbrowser.open(url)
Expand Down

0 comments on commit 61b208e

Please sign in to comment.