Use just-the-readme and update README
This commit is contained in:
42
.github/workflows/jekyll-gh-pages.yml
vendored
42
.github/workflows/jekyll-gh-pages.yml
vendored
@@ -22,24 +22,40 @@ concurrency:
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
# Build job
|
||||
# Build job (github-pages-build)
|
||||
build:
|
||||
name: Build (github-pages-build gem)
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
PAGES_REPO_NWO: ${{ github.repository }}
|
||||
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
JEKYLL_ENV: production
|
||||
NODE_ENV: production
|
||||
steps:
|
||||
- name: Checkout
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v4
|
||||
- name: Convert URLs to Autolink Format
|
||||
run: |
|
||||
# Find all markdown files and convert URLs to <autolink> format
|
||||
find . -name "*.md" -exec sed -i 's#\([^<]\)\(http[s]\?://[^\s)\]]\+\)#[\1](<\2>)#g' {} +
|
||||
- name: Setup Pages
|
||||
uses: actions/configure-pages@v5
|
||||
- name: Build with Jekyll
|
||||
uses: actions/jekyll-build-pages@v1
|
||||
- name: Setup Ruby Environment
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
source: ./
|
||||
destination: ./_site
|
||||
- name: Upload artifact
|
||||
ruby-version: "3.3"
|
||||
bundler-cache: true # runs 'bundle install' to install and cache gems
|
||||
- name: Add a YAML front matter to README.md
|
||||
run: |
|
||||
ex README.md <<EOF
|
||||
1i
|
||||
---
|
||||
title: Home
|
||||
layout: home
|
||||
nav_order: 1
|
||||
nav_enabled: false
|
||||
permalink: /
|
||||
---
|
||||
.
|
||||
wq
|
||||
EOF
|
||||
- name: Build Jekyll Site
|
||||
run: bundle exec jekyll build
|
||||
- name: Upload artifact for Pages
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
|
||||
# Deployment job
|
||||
|
||||
20
Gemfile
Normal file
20
Gemfile
Normal file
@@ -0,0 +1,20 @@
|
||||
source "https://rubygems.org"
|
||||
gemspec
|
||||
|
||||
gem "jekyll-github-metadata", ">= 2.15"
|
||||
|
||||
gem "jekyll-include-cache", group: :jekyll_plugins
|
||||
gem "jekyll-sitemap", group: :jekyll_plugins
|
||||
|
||||
gem "html-proofer", "~> 5.0", :group => :development
|
||||
|
||||
gem 'jekyll-autolinks'
|
||||
|
||||
gem 'kramdown-parser-gfm'
|
||||
gem "jekyll-remote-theme"
|
||||
|
||||
#------------------------------------------------------------------------------------------------
|
||||
# After modifying the Gemfile:
|
||||
#------------------------------------------------------------------------------------------------
|
||||
#bundle install
|
||||
#bundle exec jekyll serve
|
||||
10
README.md
10
README.md
@@ -129,6 +129,16 @@ The GUI displays a `[NOTE]` in the status box before performing any change, spec
|
||||
|
||||
It is recommended to copy the status history and keep it in a safe place after making changes, so that a reverse operation can be performed when needed.
|
||||
|
||||
### Incompatible models
|
||||
|
||||
For the following models there is no known way to read the EEPROM via SNMP protocol using the adopted read key and the related algorithm:
|
||||
|
||||
- [ET-2800](https://github.com/Ircama/epson_print_conf/issues/27)
|
||||
- [ET-2850 ET-2851 ET-2853 ET-2855 ET-2856](https://github.com/Ircama/epson_print_conf/issues/26)
|
||||
- [ET-4800](https://github.com/Ircama/epson_print_conf/issues/29) might not work, to be verified
|
||||
- [L3250](https://github.com/Ircama/epson_print_conf/issues/35)
|
||||
- [XP-7100 with firmware version YL25O7 (25 Jul 2024)](https://github.com/Ircama/epson_print_conf/issues/42) (firmware YL11K6 works)
|
||||
|
||||
### Using the command-line tool
|
||||
|
||||
```
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
remote_theme: ircama/just-the-docs
|
||||
remote_theme: ircama/just-the-readme
|
||||
|
||||
# Enable or disable the site search
|
||||
# Supports true (default) or false
|
||||
search_enabled: false
|
||||
search_enabled: true
|
||||
|
||||
# For copy button on code
|
||||
enable_copy_code_button: true
|
||||
|
||||
20
just-the-readme.gemspec
Normal file
20
just-the-readme.gemspec
Normal file
@@ -0,0 +1,20 @@
|
||||
# coding: utf-8
|
||||
|
||||
Gem::Specification.new do |spec|
|
||||
spec.name = "just-the-readme"
|
||||
spec.version = "0.0.1"
|
||||
spec.authors = ["Ircama"]
|
||||
|
||||
spec.summary = %q{A modern, highly customizable, and responsive Jekyll theme for README documentation with built-in search.}
|
||||
spec.homepage = "https://github.com/Ircama/just-the-readme"
|
||||
spec.license = "MIT"
|
||||
|
||||
spec.add_development_dependency "bundler", ">= 2.3.5"
|
||||
spec.add_runtime_dependency "sass-embedded", "~> 1.78.0" # Fix use of deprecated sass lighten() and darken()
|
||||
spec.add_runtime_dependency "jekyll", ">= 3.8.5"
|
||||
spec.add_runtime_dependency "jekyll-seo-tag", ">= 2.0"
|
||||
spec.add_runtime_dependency "jekyll-include-cache"
|
||||
spec.add_runtime_dependency "rake", ">= 12.3.1"
|
||||
spec.add_runtime_dependency "base64"
|
||||
spec.add_runtime_dependency "csv"
|
||||
end
|
||||
5
ui.py
5
ui.py
@@ -85,8 +85,9 @@ class EpcTextConsole(TextConsole):
|
||||
tk.END,
|
||||
(
|
||||
"- Clear Console: Clears all text in the console.\n"
|
||||
"- Context Menu: Right-click for cut, copy, paste, or clear.\n"
|
||||
"- Help: Provides this text.\n\n"
|
||||
"- History: Open a separate window showing the list of"
|
||||
" successfully executed commands (browse the command history).\n"
|
||||
"- Context Menu: Right-click for cut, copy, paste, or clear.\n\n"
|
||||
)
|
||||
)
|
||||
help_text.insert(
|
||||
|
||||
Reference in New Issue
Block a user