Add <link rel="canonical"> for the latest API docs

crystal-lang · Apr 22, 2018 · daf1ac7 · daf1ac7
1 parent 2f2c04f
commit daf1ac7
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/src/compiler/crystal/tools/doc/html/main.html b/src/compiler/crystal/tools/doc/html/main.html
@@ -5,8 +5,9 @@
   <meta id="repository-name" content="<%= repository_name %>">
   <title>README - <%= repository_name %></title>
   <script type="text/javascript">
-  CrystalDoc.base_path = "";
+    CrystalDoc.base_path = "";
   </script>
+  <link rel="canonical" href="<%= LATEST_API_URL %>" />
 </head>
 <body>
 

diff --git a/src/compiler/crystal/tools/doc/html/type.html b/src/compiler/crystal/tools/doc/html/type.html
@@ -7,6 +7,7 @@
   <script type="text/javascript">
     CrystalDoc.base_path = "<%= type.path_to "" %>";
   </script>
+  <link rel="canonical" href="<%= "#{LATEST_API_URL}/#{type.path}" %>" />
 </head>
 <body>
 

diff --git a/src/compiler/crystal/tools/doc/main.cr b/src/compiler/crystal/tools/doc/main.cr
@@ -1,4 +1,6 @@
 module Crystal::Doc
+  LATEST_API_URL = "https://crystal-lang.org/api/latest"
+
   record Main, body : String, program : Type, repository_name : String do
     def to_s(io : IO)
       to_json(io)