Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Re-introduce canonical URL for docs generator #9917

Merged
merged 2 commits into from
Dec 1, 2020
Merged

Re-introduce canonical URL for docs generator #9917

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ce9a7
Re-introduce canonical URL for docs generator
straight-shoota Nov 14, 2020
4d01d46
Merge remote-tracking branch 'upstream/master' into feature/canonical…
straight-shoota Nov 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions man/crystal.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,8 @@ line number
If this option is missing and can't be automatically determined, the generator can't produce source code links.
.It Fl o Ar DIR, Fl -output Ar DIR
Set the output directory (default: ./docs).
.It Fl b Ar URL, Fl -canonical-base-url Ar URL
Indicate the preferred URL with rel="canonical" link element.
.It Fl b Ar URL, Fl -sitemap-base-url Ar URL
Set the sitemap base URL. Sitemap will only be generated when this option is set.
.It Fl -sitemap-priority Ar PRIO
Expand Down
4 changes: 2 additions & 2 deletions src/compiler/crystal/command/docs.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ class Crystal::Command
project_info.json_config_url = value
end

opts.on("--canonical-base-url=URL", "Deprecated option. Use --sitemap-base-url instead.") do |value|
abort "Option --canonical-base-url is no longer supported. Use --sitemap-base-url instead."
opts.on("--canonical-base-url=URL", %(Indicate the preferred URL with rel="canonical" link element)) do |value|
project_info.canonical_base_url = value
end

opts.on("--sitemap-base-url=URL", "-b URL", "Set the sitemap base URL and generates sitemap") do |value|
Expand Down
8 changes: 8 additions & 0 deletions src/compiler/crystal/tools/doc/html/_head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@
<meta name="crystal_docs.json_config_url" content="<%= json_config_url %>">
<% end %>

<%- if canonical_base_url = project_info.canonical_base_url -%>
<%- if current_type = self.current_type -%>
<link rel="canonical" href="<%= ::Path.posix(canonical_base_url, current_type.path) %>">
<%- else -%>
<link rel="canonical" href="<%= canonical_base_url %>">
<% end -%>
<% end -%>

<link href="<%= base_path %>css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="<%= base_path %>js/doc.js"></script>

Expand Down
2 changes: 1 addition & 1 deletion src/compiler/crystal/tools/doc/html/main.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<%= HeadTemplate.new(project_info, "") %>
<%= HeadTemplate.new(project_info, nil) %>
<meta id="repository-name" content="<%= project_info.name %>">
<title><%= project_info.name %> <%= project_info.version %></title>
<script type="text/javascript">
Expand Down
2 changes: 1 addition & 1 deletion src/compiler/crystal/tools/doc/html/type.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<%= HeadTemplate.new(project_info, type.path_to "") %>
<%= HeadTemplate.new(project_info, type) %>
<meta id="repository-name" content="<%= project_info.name %>">
<title><%= type.full_name %> - <%= project_info.name %> <%= project_info.version %></title>
<script type="text/javascript">
Expand Down
1 change: 1 addition & 0 deletions src/compiler/crystal/tools/doc/project_info.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ module Crystal::Doc
property json_config_url : String? = nil
property refname : String? = nil
property source_url_pattern : String? = nil
property canonical_base_url : String? = nil

def initialize(@name : String? = nil, @version : String? = nil, @refname : String? = nil, @source_url_pattern : String? = nil)
end
Expand Down
10 changes: 9 additions & 1 deletion src/compiler/crystal/tools/doc/templates.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,15 @@ module Crystal::Doc
ECR.def_to_s "#{__DIR__}/html/main.html"
end

record HeadTemplate, project_info : ProjectInfo, base_path : String do
record HeadTemplate, project_info : ProjectInfo, current_type : Type? do
def base_path
if current_type = self.current_type
current_type.path_to ""
else
""
end
end

ECR.def_to_s "#{__DIR__}/html/_head.html"
end

Expand Down