Merge pull request #366 from remote-jp/add-schema-org-organization

Schema.org Organization タイプを企業ページに追加

Author: yasulab

docs/Rakefile

@@ -22,11 +22,14 @@ require 'html-proofer'
 # cf. GitHub - gjtorikian/html-proofer
 # https://github.com/gjtorikian/html-proofer
 
+# Load custom checks
+Dir['_tests/*.rb'].each { |file| require_relative file }
+
 task test: [:build] do
   options = {
     allow_hash_href:  true,
     disable_external: true,
-    checks: ['Links', 'Images', 'OpenGraph', 'Favicon'],
+    checks: ['Links', 'Images', 'OpenGraph', 'Favicon', 'JsonLdCheck'],
 
     # NOTE: You can ignore file, URL, and response as follows
     ignore_files: [

docs/_data/translations.yml

@@ -14,7 +14,7 @@ viewOnGitHub:
 
 titleDescription:
   en: 'Tech companies in Japan that hire remote workers.'
-  ja: 'Tech companies in Japan that hire remote workers.'
+  ja: 'リモートワークを採用している日本のテクノロジー企業のまとめ。'
 
 searchPlaceholder:
   en: 'e.g. '

docs/_includes/head.html

@@ -62,4 +62,15 @@
     <meta name="twitter:card"        content="summary">
     <meta name="twitter:image"       content="{{ site.url }}/assets/img/twitter_card.png">
     <meta itemprop="image"           content="{{ site.url }}/assets/img/twitter_card.png">
+
+    <!-- Schema.org JSON-LD -->
+    {% if page.layout == 'post' and page.domain %}
+    <script type="application/ld+json">
+      {% include organization-json-ld.json %}
+    </script>
+    {% else %}
+    <script type="application/ld+json">
+      {% include website-json-ld.json %}
+    </script>
+    {% endif %}
   </head>

docs/_includes/organization-json-ld.json

@@ -0,0 +1,11 @@
+{
+  "@context": "https://schema.org",
+  "@type": "Organization",
+  "name": "{{ page.title }}",
+  "url": "{{ page.link }}",
+  "description": {{ page.description | jsonify }},
+  "address": {
+    "@type": "PostalAddress",
+    "addressCountry": "JP"
+  }
+}

docs/_includes/website-json-ld.json

@@ -0,0 +1,8 @@
+{
+  "@context": "https://schema.org",
+  "@type": "WebSite",
+  "name": "{{ site.title }}",
+  "url": "{{ site.url }}/",
+  "description": "{{ site.data.translations.titleDescription[page.lang] }}",
+  "inLanguage": ["en", "ja"]
+}

docs/_tests/json_ld_check.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'json'
+
+class JsonLdCheck < HTMLProofer::Check
+  def run
+    @html.css('script[type="application/ld+json"]').each do |script|
+      check_json_ld(script)
+    end
+  end
+
+  private
+
+  def check_json_ld(script)
+    json_text = script.content.strip
+
+    # Check if JSON is valid
+    begin
+      JSON.parse(json_text)
+    rescue JSON::ParserError => e
+      add_failure("Invalid JSON-LD: #{e.message}")
+    end
+  end
+end