Feat/check links (#125)

* always run CI, check for html errors

* fix links

* switch a tags to div

* add alt text

* fix internal links

* remove unneeded example section

* remove legacy section

* update requirements

* test more

* fix flag

.github/workflows/deploy.yml

@@ -1,9 +1,7 @@
 name: Build pages and publish
 
 on:
-  push:
-    branches:
-    - main
+  push
 
 jobs:
   build:
@@ -23,7 +21,10 @@ jobs:
         uses: limjh16/jekyll-action-ts@v2
         with:
           enable_cache: true
+      - run: bundle exec htmlproofer ./_site --enforce-https=false
+        name: Check links
       - name: Deploy
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main'}}
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

Gemfile

@@ -10,3 +10,4 @@ group :jekyll_plugins do
     gem 'jekyll_custom_permalink'
 end
 gem "webrick", "~> 1.7"
+gem 'html-proofer'

Gemfile.lock

@@ -13,13 +13,23 @@ GEM
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
     eventmachine (1.2.7)
     ffi (1.15.5)
     forwardable-extended (2.6.0)
-    google-protobuf (3.21.12-x86_64-linux)
     html-pipeline (2.14.3)
       activesupport (>= 2)
       nokogiri (>= 1.4)
+    html-proofer (4.4.3)
+      addressable (~> 2.3)
+      mercenary (~> 0.3)
+      nokogiri (~> 1.13)
+      parallel (~> 1.10)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+      zeitwerk (~> 2.5)
     http_parser.rb (0.8.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -64,12 +74,16 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
     minitest (5.17.0)
+    nokogiri (1.14.0-aarch64-linux)
+      racc (~> 1.4)
     nokogiri (1.14.0-x86_64-linux)
       racc (~> 1.4)
+    parallel (1.22.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (5.0.1)
     racc (1.6.2)
+    rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -80,15 +94,20 @@ GEM
       ffi (~> 1.9)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
     webrick (1.7.0)
+    yell (2.2.2)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  html-proofer
   jekyll
   jekyll-feed
   jekyll-mentions
@@ -99,4 +118,4 @@ DEPENDENCIES
   webrick (~> 1.7)
 
 BUNDLED WITH
-   2.3.26
+   2.4.6

_data/functions/extras.yml

@@ -7,4 +7,4 @@ functions:
     link: https://docs.inventree.org/en/latest/report/report/
   - title: Extend and Customize
     text: InvenTree is designed to be highly extensible. If the core InvenTree functionality does not meet your particular need, InvenTree provides a RESTful API, a native Python library, and a powerful plugin system.
-    link: https://docs.inventree.org/en/latest/extend/api/
+    link: https://docs.inventree.org/en/latest/api/api/

_includes/base/footer.html

@@ -1,10 +1,10 @@
 <footer class="cm-gray-2 body-font">
   <div class="container px-5 pt-8 mx-auto flex md:flex-row md:flex-nowrap flex-wrap flex-col">
     <div class="w-64 flex-shrink-0 md:mx-0 mx-auto text-center md:text-left">
-      <a class="flex title-font font-medium items-center md:justify-start justify-center cm-gray-1">
+      <div class="flex title-font font-medium items-center md:justify-start justify-center cm-gray-1">
         <img src="{{ '/assets/logo.png' | relative_url }}" alt="logo" height="32" width="32" class="h-8">
         <span class="ml-3 text-xl">{{ site.title }}</span>
-      </a>
+      </div>
       <p class="mt-2 text-sm cm-gray-3">{{ site.tagline }}</p>
     </div>
 

_includes/block/features.html

@@ -2,7 +2,7 @@
     <div class="section-container">
       <div class="flex flex-wrap w-full mb-4">
         <div class="lg:w-1/2 w-full mb-6 lg:mb-0">
-          <a class="anchor" id="{{ include.data.ref }}"></a>
+          <div class="anchor" id="{{ include.data.ref }}"></div>
           <div class="inline-flex items-center">
             <h1 class="header-text title-font mb-2 cm-gray-1">{{ include.data.title }}</h1>
             {% if include.link %}

_includes/partial/newsletter.html

@@ -1,5 +1,5 @@
 <!-- Begin Mailchimp Signup Form -->
-<link href="//cdn-images.mailchimp.com/embedcode/classic-071822.css" rel="stylesheet" type="text/css">
+<link href="https://cdn-images.mailchimp.com/embedcode/classic-071822.css" rel="stylesheet" type="text/css">
 <style type="text/css">
 	#mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif;  width:600px;}
 	/* Add your own Mailchimp form style overrides in your site stylesheet or in this style block.
@@ -73,7 +73,7 @@
         <div class="optionalParent">
             <div class="clear foot">
                 <input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="button">
-                <p class="brandingLogo"><a href="http://eepurl.com/h5Mg8D" title="Mailchimp - email marketing made easy and fun"><img src="https://eep.io/mc-cdn-images/template_images/branding_logo_text_dark_dtp.svg"></a></p>
+                <p class="brandingLogo"><a href="https://eepurl.com/h5Mg8D" title="Mailchimp - email marketing made easy and fun"><img src="https://eep.io/mc-cdn-images/template_images/branding_logo_text_dark_dtp.svg" alt="Mailchimp logo"></a></p>
             </div>
         </div>
     </div>

_layouts/collection/collection_index.html

@@ -3,7 +3,7 @@ layout: default
 ---
   <section class="cm-gray-2 body-font">
     <div class="pt-3 pb-1 section-container">
-      <h1 class="header-text title-font mb-4 cm-gray-2 flex items-end">{{ page.title_text }}<a href="{{ page.permalink|append:'/feed.atom' }}" alr="Atom feed" class="ml-3 cm-gray-3"><img class="h-5 w-5" src="{{ '/assets/rss.svg' | relative_url }}" /></a></h1>
+      <h1 class="header-text title-font mb-4 cm-gray-2 flex items-end">{{ page.title_text }}<a href="{{ page.permalink|append:'/feed.atom' }}" alr="Atom feed" class="ml-3 cm-gray-3"><img class="h-5 w-5" src="{{ '/assets/rss.svg' | relative_url }}" alt="RSS symbol"/></a></h1>
       <div class="flex flex-wrap">
 
       {% assign cols = site[page.collection] %}

_news/2022-11-14-website.md

@@ -17,7 +17,7 @@ inventree.org will no longer host the InvenTree software documentation. Document
 
 ### Demo Server
 
-The [demo server](/demo.md) remains available at [demo.inventree.org](https://demo.inventree.org)
+The [demo server]({% link demo.md %}) remains available at [demo.inventree.org](https://demo.inventree.org)
 
 ### Credits
 

_posts/2021-11-22-translation.md

@@ -29,7 +29,7 @@ There are many files within the InvenTree project which can provide these transl
 - Javascript source files
 - HTML template files
 
-Additionally, translation support is provided for the [InvenTree Mobile App](/extend/app.md)!
+Additionally, translation support is provided for the [InvenTree Mobile App]({% link extend/app.md %})!
 
 #### Exporting Translations - GitHub
 
@@ -51,7 +51,7 @@ Updated translated strings are periodically merged back into the main code branc
 
 The translation framework is provided by the InvenTree team to make our software more useful and appealing to a greater number of people. The entire translation effort is driven by the InvenTree community. Any contributions, no matter how large or small, are greatly encouraged!
 
-If you would like to see improved translations in a particular language, read the [contribution guide](/contribute.md#translate)! The InvenTree project benefits greatly from your efforts, and you get a great piece of open source software in your native language.
+If you would like to see improved translations in a particular language, read the [contribution guide]({% link contribute.md %}#translate)! The InvenTree project benefits greatly from your efforts, and you get a great piece of open source software in your native language.
 
 #### Adding New Languages
 

_posts/2023-01-02-upcoming.md

@@ -33,7 +33,7 @@ Our new website (inventree.org) is now up and running! Thanks to @matmair in par
 
 ### Translations
 
-[Translations](/contribute.md#translate) for the InevnTree project continue to grow, thanks to our vibrant community of users. Thanks to the [crowdin project](https://crowdin.com) which makes this possible.
+[Translations]({% link contribute.md %}#translate) for the InevnTree project continue to grow, thanks to our vibrant community of users. Thanks to the [crowdin project](https://crowdin.com) which makes this possible.
 
 ### Users
 

_publishers/SergeoLacruz.md

@@ -2,6 +2,6 @@
 short_name: SergeoLacruz
 name: Michael
 github: SergeoLacruz
-website: www.buchmann.ruhr
+website: http://www.buchmann.ruhr
 ---
 Hardware engineer in Germany and vintage fan.

deploy.md

@@ -19,8 +19,8 @@ A [bare metal installation guide](https://docs.inventree.org/en/latest/start/int
 
 ### Cloud
 
-A member of the team provides a [1-click app for InvenTree](https://marketplace.digitalocean.com/apps/inventree?refcode=d6172576d014&action=deploy) on the DigitalOcean marketplace.
+A member of the team provides a [1-click app for InvenTree](https://marketplace.digitalocean.com/apps/inventree?refcode=d6172576d014) on the DigitalOcean marketplace.
 
 ### Other Options
 
-The core InvenTree server is built using the widely used python-based framework [Django](https://djangoproject.com/). Therefore there are  deployment methods for nearly all plattforms and architectures. If you want to read more about InvenTree's structure and a typical installation read the [architecture overview](../contribute/code/architecture).
+The core InvenTree server is built using the widely used python-based framework [Django](https://djangoproject.com/). Therefore there are  deployment methods for nearly all plattforms and architectures. 

extend/app.md

@@ -25,7 +25,7 @@ The InvenTree app can be downloaded from either the Android or Apple app stores,
 
 <span class='fab fa-android'></span> [Android Play Store](https://play.google.com/store/apps/details?id=inventree.inventree_app).
 
-<span class='fab fa-apple'></span> [Apple App Store](https://apps.apple.com/au/app/inventree/id1581731101#?platform=iphone)
+<span class='fab fa-apple'></span> [Apple App Store](https://apps.apple.com/au/app/inventree/id1581731101?platform=iphone)
 
 ### Documentation
 

extend/index.md

@@ -8,4 +8,4 @@ InvenTree is designeds to be part of a larger system of tools to support both ho
 - [API](api)
 - [Integrate](integrate) into other tools
 - PK2InvenTree for [migrating from PartKeepr to InvenTreen](https://github.com/rgilham/PK2InvenTree)
-- Python [package](https://docs.inventree.org/en/latest/extend/python/) 
+- Python [package](https://docs.inventree.org/en/latest/api/python/python/) 

support.md

@@ -12,7 +12,7 @@ Private questions (via DM, email, etc.) are generally not answered, use the publ
 If you require a custom feature you can either:
 - Suggest the feature on the issue tracker as a [Feature Request](https://github.com/inventree/InvenTree/issues/new?template=feature_request.yaml)
 - Implement the feature yourself, and contribute back to the project. InvenTree developers will happily help you work through any issues.
-- Create a [plugin](/extend/plugin/index.md)
+- Create a [plugin]({% link extend/plugin/index.md %})
 - Request a paid customisation
 
 ## Paid Customisation / Support

use/maker.md

@@ -3,14 +3,4 @@ layout: user
 title: For Maker
 title_2: for Maker
 data: for_maker
-long_text: |
-    lorem ipsum place for
-    multiline inteligent text
-buttons:
-    - text: lorem ipsum primary
-      primary: true
-      link: http://example.com
-    - text: lorem ipsum
-      link:
-        site: plugn-link
 ---