Add favicon (#149)

* Fix mobile menu

* Link cover page

* Add home link

* Add favicon

This adds a favicon to the book
This commit is contained in:
Hendrik Kleinwaechter
2023-07-13 17:23:06 +02:00
committed by GitHub
parent fa91b6f06f
commit 442a3ec032
3 changed files with 58 additions and 6 deletions

View File

@@ -18,6 +18,7 @@ class ModifyBuild
system("rm -rf #{build_dir}/")
system("mkdir #{build_dir}/")
copy_source_to_local_dir_for_modification
copy_assets_into_folder
list_of_files_to_modify.each do |filename|
modify_file(filename)
end
@@ -34,6 +35,7 @@ class ModifyBuild
text = fix_cover_page(text) if is_cover_page?(filename)
text = add_home_link_to_menu(text)
text = fix_anchor_hyperlinks_menu(text)
text = add_favicon(text)
File.open(filename, "w") {|file| file.puts text }
end
@@ -52,6 +54,10 @@ class ModifyBuild
system("cp -R ../book/#{build_dir}/* #{build_dir}")
end
def copy_assets_into_folder
system("cp -R ./assets/* #{build_dir}")
end
def source_website_output_exists?
File.directory?("../book/#{build_dir}/")
end
@@ -68,7 +74,7 @@ class ModifyBuild
doc = build_doc(text)
elements = [doc.search('.chapterToc'), doc.search('.sectionToc'), doc.search('.subsectionToc')].flatten
elements.each do |n|
chapter_number_or_nothing = n.children[0].text.strip
chapter_number_or_nothing = n.children[0].text.strip.to_i
hyperlink_node = n.children[1]
next if hyperlink_node.nil?
@@ -76,7 +82,7 @@ class ModifyBuild
n.children[0].remove
link_text = hyperlink_node.content
# no chapter number
if chapter_number_or_nothing.length == 0
if chapter_number_or_nothing == 0
content = hyperlink_node.to_s
else
link_node_content = %Q{
@@ -163,6 +169,48 @@ class ModifyBuild
doc.to_html
end
# By default the menu is not made for mobile devices. This adds mobile
# capabilities to the menu
def fix_menu(text)
doc = build_doc(text)
nav = doc.css("nav.TOC")[0]
# page has no nav
return text unless nav
menu_items_html = doc.css("nav.TOC > *").to_html
nav.add_class("menu")
nav_content = %Q{
#{menu_mobile_nav}
<div class="menu-items">#{menu_items_html}</div>
}
nav.inner_html = nav_content
doc.to_html
end
def menu_mobile_nav
%Q{
<a href="/" class="logo">
The Sourdough Framework
</a>
<input type="checkbox" id="toggle-menu">
<label class="hamb toggle-menu-label" for="toggle-menu"><span class="hamb-line"></span></label>
}
end
# The cover page should have some additional content and allow the user to
# click the book cover in order to start reading.
def fix_cover_page(text)
doc = build_doc(text)
body = doc.css("body")[0]
content = doc.css("body > .titlepage")[0]
menu = doc.css("body > .menu")[0]
cover = content.css(".center")[0]
cover_html = cover.to_html
cover.inner_html = "<a href='Thehistoryofsourdough.html'>#{cover_html}</a>"
body.inner_html = "#{menu} #{content}"
doc.to_html
end
# Users are lost and can't easily access the root page of the book. This
# adds a home menu item.
def add_home_link_to_menu(text)
@@ -192,6 +240,14 @@ class ModifyBuild
doc.to_html
end
def add_favicon(text)
doc = build_doc(text)
head = doc.css("head")[0]
fav_html = %Q{<link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />}
head.inner_html = "#{head.inner_html} #{fav_html}"
doc.to_html
end
def build_doc(text)
Nokogiri::HTML(text)
end