mirror of
https://github.com/halfrost/LeetCode-Go.git
synced 2025-07-28 06:33:59 +08:00
117 lines
16 KiB
HTML
117 lines
16 KiB
HTML
<!doctype html><html lang=en><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Move static content to static # Jekyll has a rule that any directory not starting with _ will be copied as-is to the _site output. Hugo keeps all static content under static. You should therefore move it all there. With Jekyll, something that looked like
|
|
▾ <root>/ ▾ images/ logo.png should become
|
|
▾ <root>/ ▾ static/ ▾ images/ logo.png Additionally, you’ll want any files that should reside at the root (such as CNAME) to be moved to static."><meta name=theme-color content="#FFFFFF"><meta property="og:title" content="Migrate to Hugo from Jekyll"><meta property="og:description" content="Move static content to static # Jekyll has a rule that any directory not starting with _ will be copied as-is to the _site output. Hugo keeps all static content under static. You should therefore move it all there. With Jekyll, something that looked like
|
|
▾ <root>/ ▾ images/ logo.png should become
|
|
▾ <root>/ ▾ static/ ▾ images/ logo.png Additionally, you’ll want any files that should reside at the root (such as CNAME) to be moved to static."><meta property="og:type" content="article"><meta property="og:url" content="https://books.halfrost.com/leetcode/posts/migrate-from-jekyll/"><meta property="article:published_time" content="2014-03-10T00:00:00+00:00"><meta property="article:modified_time" content="2014-03-10T00:00:00+00:00"><title>Migrate to Hugo from Jekyll | LeetCode Cookbook</title><link rel=manifest href=/leetcode/manifest.json><link rel=icon href=/leetcode/favicon.png type=image/x-icon><link rel=stylesheet href=/leetcode/book.min.6cd8553a6854f4812343f0f0c8baca31271e686434f381fbe3c7226f66639176.css integrity="sha256-bNhVOmhU9IEjQ/DwyLrKMSceaGQ084H748cib2ZjkXY="><script defer src=/leetcode/en.search.min.b89b298482a620ecdc3740829351c9d8b19cc485f00b83eaf4b57f44e1cb7e23.js integrity="sha256-uJsphIKmIOzcN0CCk1HJ2LGcxIXwC4Pq9LV/ROHLfiM="></script><script defer src=/leetcode/sw.min.f4d2776936ea9603d5b4d06bf489597dd2355c0a24f090e9e6dc2679587a2034.js integrity="sha256-9NJ3aTbqlgPVtNBr9IlZfdI1XAok8JDp5twmeVh6IDQ="></script></head><body><input type=checkbox class="hidden toggle" id=menu-control>
|
|
<input type=checkbox class="hidden toggle" id=toc-control><main class="container flex"><aside class=book-menu><nav><h2 class=book-brand><a href=/leetcode><span>LeetCode Cookbook</span></a></h2><div class=book-search><input type=text id=book-search-input placeholder=Search aria-label=Search maxlength=64 data-hotkeys=s/><div class="book-search-spinner hidden"></div><ul id=book-search-results></ul></div><ul><li><a href=https://halfrost.com target=_blank rel=noopener>被人嘲笑的梦想</a></li><li><a href=https://github.com/halfrost target=_blank rel=noopener>Github</a></li><li><a href=https://halfrost.com target=_blank rel=noopener>微信公众号</a></li><li><a href=https://twitter.com/halffrost target=_blank rel=noopener>Twitter</a></li><li><a href=https://weibo.com/halfrost target=_blank rel=noopener>Weibo</a></li></ul><ul><li><p><a href=/leetcode/docs/example/><strong>Example Site</strong></a></p></li><li><p><a href=/leetcode/docs/example/table-of-contents/>Table of Contents</a></p><ul><li><a href=/leetcode/docs/example/table-of-contents/with-toc/>With ToC</a></li><li><a href=/leetcode/docs/example/table-of-contents/without-toc/>Without ToC</a></li></ul></li><li><p><a href=/leetcode/docs/example/collapsed/>Collapsed</a></p><ul><li><a href=/leetcode/docs/example/collapsed/3rd-level/>3rd</a><ul><li><a href=/leetcode/docs/example/collapsed/3rd-level/4th-level/>4th</a><br></li></ul></li></ul></li><li><p><strong>Shortcodes</strong></p></li><li><p><a href=/leetcode/docs/shortcodes/buttons/>Buttons</a></p></li><li><p><a href=/leetcode/docs/shortcodes/columns/>Columns</a></p></li><li><p><a href=/leetcode/docs/shortcodes/expand/>Expand</a></p></li><li><p><a href=/leetcode/docs/shortcodes/hints/>Hints</a></p></li><li><p><a href=/leetcode/docs/shortcodes/katex/>Katex</a></p></li><li><p><a href=/leetcode/docs/shortcodes/mermaid/>Mermaid</a></p></li><li><p><a href=/leetcode/docs/shortcodes/tabs/>Tabs</a><br></p></li></ul><ul><li><a href=/leetcode/posts/>Blog</a></li></ul></nav><script>(function(){var menu=document.querySelector("aside.book-menu nav");addEventListener("beforeunload",function(event){localStorage.setItem("menu.scrollTop",menu.scrollTop);});menu.scrollTop=localStorage.getItem("menu.scrollTop");})();</script></aside><div class=book-page><header class=book-header><div class="flex align-center justify-between"><label for=menu-control><img src=/leetcode/svg/menu.svg class=book-icon alt=Menu></label>
|
|
<strong>Migrate to Hugo from Jekyll</strong>
|
|
<label for=toc-control><img src=/leetcode/svg/toc.svg class=book-icon alt="Table of Contents"></label></div><aside class="hidden clearfix"><nav id=TableOfContents><ul><li><ul><li><a href=#move-static-content-to-static>Move static content to <code>static</code></a></li><li><a href=#create-your-hugo-configuration-file>Create your Hugo configuration file</a></li><li><a href=#set-your-configuration-publish-folder-to-_site>Set your configuration publish folder to <code>_site</code></a></li><li><a href=#convert-jekyll-templates-to-hugo-templates>Convert Jekyll templates to Hugo templates</a></li><li><a href=#convert-jekyll-plugins-to-hugo-shortcodes>Convert Jekyll plugins to Hugo shortcodes</a><ul><li><a href=#implementation>Implementation</a></li><li><a href=#usage>Usage</a></li></ul></li><li><a href=#finishing-touches>Finishing touches</a><ul><li><a href=#fix-content>Fix content</a></li><li><a href=#clean-up>Clean up</a></li></ul></li><li><a href=#a-practical-example-in-a-diff>A practical example in a diff</a></li></ul></li></ul></nav></aside></header><article class=markdown><h1><a href=/leetcode/posts/migrate-from-jekyll/>Migrate to Hugo from Jekyll</a></h1><h5>Mar 10, 2014</h5><p><h2 id=move-static-content-to-static>Move static content to <code>static</code>
|
|
<a class=anchor href=#move-static-content-to-static>#</a></h2><p>Jekyll has a rule that any directory not starting with <code>_</code> will be copied as-is to the <code>_site</code> output. Hugo keeps all static content under <code>static</code>. You should therefore move it all there.
|
|
With Jekyll, something that looked like</p><pre><code>▾ <root>/
|
|
▾ images/
|
|
logo.png
|
|
</code></pre><p>should become</p><pre><code>▾ <root>/
|
|
▾ static/
|
|
▾ images/
|
|
logo.png
|
|
</code></pre><p>Additionally, you’ll want any files that should reside at the root (such as <code>CNAME</code>) to be moved to <code>static</code>.</p><h2 id=create-your-hugo-configuration-file>Create your Hugo configuration file
|
|
<a class=anchor href=#create-your-hugo-configuration-file>#</a></h2><p>Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the
|
|
<a href=/overview/configuration/>Hugo configuration documentation</a> for details.</p><h2 id=set-your-configuration-publish-folder-to-_site>Set your configuration publish folder to <code>_site</code>
|
|
<a class=anchor href=#set-your-configuration-publish-folder-to-_site>#</a></h2><p>The default is for Jekyll to publish to <code>_site</code> and for Hugo to publish to <code>public</code>. If, like me, you have
|
|
<a href=http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html><code>_site</code> mapped to a git submodule on the <code>gh-pages</code> branch</a>, you’ll want to do one of two alternatives:</p><ol><li><p>Change your submodule to point to map <code>gh-pages</code> to public instead of <code>_site</code> (recommended).</p><pre><code> git submodule deinit _site
|
|
git rm _site
|
|
git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
|
|
</code></pre></li><li><p>Or, change the Hugo configuration to use <code>_site</code> instead of <code>public</code>.</p><pre><code> {
|
|
..
|
|
"publishdir": "_site",
|
|
..
|
|
}
|
|
</code></pre></li></ol><h2 id=convert-jekyll-templates-to-hugo-templates>Convert Jekyll templates to Hugo templates
|
|
<a class=anchor href=#convert-jekyll-templates-to-hugo-templates>#</a></h2><p>That’s the bulk of the work right here. The documentation is your friend. You should refer to
|
|
<a href=http://jekyllrb.com/docs/templates/>Jekyll’s template documentation</a> if you need to refresh your memory on how you built your blog and
|
|
<a href=/layout/templates/>Hugo’s template</a> to learn Hugo’s way.</p><p>As a single reference data point, converting my templates for
|
|
<a href=http://heyitsalex.net/>heyitsalex.net</a> took me no more than a few hours.</p><h2 id=convert-jekyll-plugins-to-hugo-shortcodes>Convert Jekyll plugins to Hugo shortcodes
|
|
<a class=anchor href=#convert-jekyll-plugins-to-hugo-shortcodes>#</a></h2><p>Jekyll has
|
|
<a href=http://jekyllrb.com/docs/plugins/>plugins</a>; Hugo has
|
|
<a href=/doc/shortcodes/>shortcodes</a>. It’s fairly trivial to do a port.</p><h3 id=implementation>Implementation
|
|
<a class=anchor href=#implementation>#</a></h3><p>As an example, I was using a custom
|
|
<a href=https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb><code>image_tag</code></a> plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing.</p><p>Jekyll’s plugin:</p><pre><code>module Jekyll
|
|
class ImageTag < Liquid::Tag
|
|
@url = nil
|
|
@caption = nil
|
|
@class = nil
|
|
@link = nil
|
|
// Patterns
|
|
IMAGE_URL_WITH_CLASS_AND_CAPTION =
|
|
IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
|
|
IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
|
|
IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
|
|
IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
|
|
def initialize(tag_name, markup, tokens)
|
|
super
|
|
if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
|
|
@class = $1
|
|
@url = $3
|
|
@caption = $7
|
|
@link = $9
|
|
elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
|
|
@class = $1
|
|
@url = $3
|
|
@caption = $7
|
|
elsif markup =~ IMAGE_URL_WITH_CAPTION
|
|
@url = $1
|
|
@caption = $5
|
|
elsif markup =~ IMAGE_URL_WITH_CLASS
|
|
@class = $1
|
|
@url = $3
|
|
elsif markup =~ IMAGE_URL
|
|
@url = $1
|
|
end
|
|
end
|
|
def render(context)
|
|
if @class
|
|
source = "<figure class='#{@class}'>"
|
|
else
|
|
source = "<figure>"
|
|
end
|
|
if @link
|
|
source += "<a href=\"#{@link}\">"
|
|
end
|
|
source += "<img src=\"#{@url}\">"
|
|
if @link
|
|
source += "</a>"
|
|
end
|
|
source += "<figcaption>#{@caption}</figcaption>" if @caption
|
|
source += "</figure>"
|
|
source
|
|
end
|
|
end
|
|
end
|
|
Liquid::Template.register_tag('image', Jekyll::ImageTag)
|
|
</code></pre><p>is written as this Hugo shortcode:</p><pre><code><!-- image -->
|
|
<figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
|
|
{{ with .Get "link"}}<a href="{{.}}">{{ end }}
|
|
<img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
|
|
{{ if .Get "link"}}</a>{{ end }}
|
|
{{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
|
|
<figcaption>{{ if isset .Params "title" }}
|
|
{{ .Get "title" }}{{ end }}
|
|
{{ if or (.Get "caption") (.Get "attr")}}<p>
|
|
{{ .Get "caption" }}
|
|
{{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
|
|
{{ .Get "attr" }}
|
|
{{ if .Get "attrlink"}}</a> {{ end }}
|
|
</p> {{ end }}
|
|
</figcaption>
|
|
{{ end }}
|
|
</figure>
|
|
<!-- image -->
|
|
</code></pre><h3 id=usage>Usage
|
|
<a class=anchor href=#usage>#</a></h3><p>I simply changed:</p><pre><code>{% image full http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg "One of my favorite touristy-type photos. I secretly waited for the good light while we were "having fun" and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." ->http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/ %}
|
|
</code></pre><p>to this (this example uses a slightly extended version named <code>fig</code>, different than the built-in <code>figure</code>):</p><pre><code>{{% fig class="full" src="http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg" title="One of my favorite touristy-type photos. I secretly waited for the good light while we were having fun and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." link="http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/" %}}
|
|
</code></pre><p>As a bonus, the shortcode named parameters are, arguably, more readable.</p><h2 id=finishing-touches>Finishing touches
|
|
<a class=anchor href=#finishing-touches>#</a></h2><h3 id=fix-content>Fix content
|
|
<a class=anchor href=#fix-content>#</a></h3><p>Depending on the amount of customization that was done with each post with Jekyll, this step will require more or less effort. There are no hard and fast rules here except that <code>hugo server --watch</code> is your friend. Test your changes and fix errors as needed.</p><h3 id=clean-up>Clean up
|
|
<a class=anchor href=#clean-up>#</a></h3><p>You’ll want to remove the Jekyll configuration at this point. If you have anything else that isn’t used, delete it.</p><h2 id=a-practical-example-in-a-diff>A practical example in a diff
|
|
<a class=anchor href=#a-practical-example-in-a-diff>#</a></h2><p><a href=http://heyitsalex.net/>Hey, it’s Alex</a> was migrated in less than a <em>father-with-kids day</em> from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this
|
|
<a href=https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610>diff</a>.</p></p></article><footer class=book-footer><div class="flex flex-wrap justify-between"></div></footer><label for=menu-control class="hidden book-menu-overlay"></label></div><aside class=book-toc><nav id=TableOfContents><ul><li><ul><li><a href=#move-static-content-to-static>Move static content to <code>static</code></a></li><li><a href=#create-your-hugo-configuration-file>Create your Hugo configuration file</a></li><li><a href=#set-your-configuration-publish-folder-to-_site>Set your configuration publish folder to <code>_site</code></a></li><li><a href=#convert-jekyll-templates-to-hugo-templates>Convert Jekyll templates to Hugo templates</a></li><li><a href=#convert-jekyll-plugins-to-hugo-shortcodes>Convert Jekyll plugins to Hugo shortcodes</a><ul><li><a href=#implementation>Implementation</a></li><li><a href=#usage>Usage</a></li></ul></li><li><a href=#finishing-touches>Finishing touches</a><ul><li><a href=#fix-content>Fix content</a></li><li><a href=#clean-up>Clean up</a></li></ul></li><li><a href=#a-practical-example-in-a-diff>A practical example in a diff</a></li></ul></li></ul></nav></aside></main></body></html> |