hugo创建静态网页并部署到github

hugo是什么

hugo是高性能静态网页生成软件,可以将markdown文档转为静态网页。

如果你也习惯用markdown写作,那么使用hugo可以方便的将文档转为网站。

Quick start

hugo的使用非常简单,没有比官方文档更简单的介绍了。

这里的tips:

hugo new生成的markdown文档默认是不发布的,需要将文档中的draft: true改为draft: false,有些文章让你删掉这行,是错误的。

hugo生成的静态网站部署到github上

背景

github提供了静态网站托管功能,即代码库中的静态文件作为静态网站内容,可以作为一个静态网站进行展示。配置方式如下:


github-pages.png

github提供两种配置方式:

  1. 使用master分支:图中第三步;以根目录作为网站根目录或者以docs作为网站根目录,图中第四步
  2. 使用gh-pages branch,本文不对这种方式进行介绍(还没测试过)

选择的目录结构

hugo将markdown转换为静态网站,网页源代码在markdown文件中,即content目录,而生成的静态网站在docs目录。我需要网页源代码与生成的网站在同一个repository下。

因此选择github pages配置为使用master分支下得docs目录,hugo要做如下修改:

  1. 修改生成静态网站的路径,默认路径是public。 增加 publishDir = "docs" 配置到config.toml文件中
  2. 修改baseUrl,即网站root url。网页上有一个链接可以跳转回网站根目录,baseUrl即为网站根目录地址,配置为github pages的地址即可。

真的需要hugo吗

在我测试完hugo后,我决定放弃hugo了。原因有如下几点:

  • 图片的使用还是有些繁琐,image processing,shortcode等概念学习使用起来费劲。
  • 技术博客需要与网友交流,因此评论是非常重要的功能
  • 图片因为使用了image processing等概念,不兼容typora等原生markdown,在本地用typora编辑无法预览图片
  • theme的设置还是有点复杂
  • github托管静态网站,应该没办法支持搜索,文章多了的话,没有搜索还是挺麻烦的
  • 写博客也不知道能否坚持下去,有折腾的功夫,不如多码点字

对我来说,核心的需求很简单:

  • 可以用markdown写作,最好是原生markdown语法,这样可以使用typora等软件进行撰写。
  • 可以在线展示:工作中与同事协同可以方便的贴个链接过去,比如iperf的使用方法
  • 输出高质量的内容,当然希望有更多的人看到,在国内,不得不考虑github和类似简书这样的平台被搜索引擎收录的情况
  • 可以在多个平台同步,简书写一份,知乎写一份。要修改文章时同步起来就费劲了,这点目前无解

所以我放弃了hugo,如果你真的想用hugo,建议:

  1. 是否能够接受无法通过评论与网友交流,部署到github不支持站内搜索
  2. 是否能够自己折腾主题,定制各种高大上的功能,比如目录,比如tag

如果只是想通过markdown码子的话,建议还是算了。简书挺好,除了编辑器不支持typora这种模式除外。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,634评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,951评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,427评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,770评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,835评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,799评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,768评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,544评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,979评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,121评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,756评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2 352

推荐阅读更多精彩内容