run-name: ${{ github.actor }} is running Geeqie check build
on: [push, pull_request]
jobs:
+ Check-Markdown:
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v2
+ - name: Run Markdown Lint
+ uses: actionshub/markdownlint@main
+
Check-Build-No-Options:
runs-on: ubuntu-22.04
steps:
--- /dev/null
+# Style settings for markdownlint (mdl)
+
+all
+rule 'MD007', :indent => 4
+rule 'MD009', :br_spaces => 2
+rule 'MD010', :code_blocks => true
+exclude_rule 'MD013'
--- /dev/null
+# markdownlint (mdl) configuration file
+
+style '.mdl.rb'
# Additional Information for Developers
-
## Non-standard icons
-#### Collection drag-drop icon
+### Collection drag-drop icon
#### ![][image_ref_gq_marker_png]
+
Used when dropping images onto a Collection.
Defined in `./src/icons/gq-marker.xpm`.
-#### Overlay Screen Display icons
+### Overlay Screen Display icons
+
+#### ![][image_ref_image_osd_color_png] IMAGE_OSD_COLOR
+
+#### ![][image_ref_image_osd_first_png] IMAGE_OSD_FIRST
-##### ![][image_ref_image_osd_color_png] IMAGE_OSD_COLOR
-##### ![][image_ref_image_osd_first_png] IMAGE_OSD_FIRST
-##### ![][image_ref_image_osd_icon_png] IMAGE_OSD_ICON
-##### ![][image_ref_image_osd_last_png] IMAGE_OSD_LAST
-##### ![][image_ref_image_osd_rotate_auto_png] IMAGE_OSD_ROTATE_AUTO
+#### ![][image_ref_image_osd_icon_png] IMAGE_OSD_ICON
+
+#### ![][image_ref_image_osd_last_png] IMAGE_OSD_LAST
+
+#### ![][image_ref_image_osd_rotate_auto_png] IMAGE_OSD_ROTATE_AUTO
Shown in the Overlay Screen Display. Defined in `./src/image-overlay.cc image_osd_icon_pixbuf()`.
Menu processing is in `./src/layout-util.cc menu_entries[]`.
## Doxygen Documentation
+
Complete code documentation in html format can be generated via the script `./scripts/doxygen.sh`.
[image_ref_image_osd_color_png]:
Geeqie website status:
[![Links Status](https://github.com/geeqie/geeqie.github.io/actions/workflows/links.yml/badge.svg)]()
-
## ![][image_ref_geeqie_png] Geeqie - an image viewer
This is Geeqie, a successor of GQview.
*.m \
*.markdown \
*.md \
+ *.rb \
*.mm \
*.dox \
*.py \
script_sources = []
subdir('scripts')
+# For markdownlint on .md files
+mdl_sources = []
+
# For gtk builder checks on .ui files
ui_sources = []
summary({'shellcheck' : ['Test runs:', false]}, section : 'Testing', bool_yn : true)
endif
+# Markdownlint
+option = get_option('archive')
+if option.disabled()
+ mdl_exe = find_program('mdl', required : false)
+
+ if mdl_exe.found()
+ mdl_sources += files('CHECKLIST.md',
+ 'CODING.md',
+ 'DEVELOPER-NOTES.md',
+ 'README.md',
+ join_paths(meson.project_source_root(), '.github', 'ISSUE_TEMPLATE.md'))
+
+ style = join_paths(meson.project_source_root(), '.mdl.rb')
+ foreach md_file : mdl_sources
+ md_path = '@0@'.format(md_file)
+ test('Mdl_check_ ' + md_path, mdl_exe, args: ['--style', style, md_file], timeout: 100)
+ endforeach
+ summary({'markdownlint' : ['Test runs:', true]}, section : 'Testing', bool_yn : true)
+ else
+ summary({'markdownlint' : ['Test runs:', false]}, section : 'Testing', bool_yn : true)
+ endif
+else
+ summary({'markdownlint' : ['Test runs:', false]}, section : 'Testing', bool_yn : true)
+endif
+
# GtkBuilder .ui check
option = get_option('archive')
if option.disabled()