快速搭建你的 github pages 個人博客 —— 基于 Create-React-App 的單頁面應用實踐

相信各位github資深玩家們都有自己基于 github pages 搭建的個人站點。官方推薦的靜態站點生成器是 Jekyll,關于 Jekyll 的使用感興趣的各位請自行 google,這里就不贅述了。本文主要介紹下基于 Create-React-App 搭建個人博客的相關實踐,可能更適合做前端開發的伙伴。

github pages

github pagesgithub 推出的靜態站點服務,主要的用途在于使用你在 github 倉庫中的代碼構建你自己的靜態站點,為用戶提供 github.io 二級域名,您也可以通過添加DNS的 CNAME 記錄來綁定自己的域名。

github pages 最簡單粗暴的方法就是直接往 github 上方靜態頁面了,創建一個名為 [您的github賬號名].github.io 的github倉庫,將您的index.html頁面代碼扔進master分支,就可以直接通過 https://[您的github賬號名].github.io 訪問到您的站點了。

對于一個簡單的個人博客站點來說,存在以下基本功能特性:

  • 文章的新增、編輯、一鍵發布
  • 文章的分類、歸檔
  • 風格良好的博客樣式
  • 評論、SEO等等功能

下面介紹基于React如何實現一個簡單的靜態博客。

1. 創建一個 React 項目

使用 Create-React-App(以下簡稱CRA) 的generator創建一個React前端項目骨架。對此項目進行一定改造以方便我們日常的開發和使用習慣:

  • 使用react-app-rewired來調整CRA中webpack的配置
    • 對CRA的webpack配置感興趣的童鞋可以看看這篇文章
  • 使用core-js對瀏覽器版本進行向下兼容
  • 通過編寫不同的React容器組件(container)來實現不同的頁面,通過統一的json結構來配置應用的頁面路由
  • 使用螞蟻金服的antd設計語言(React組件)快速實現業務UI
  • 使用axios實現前后端的數據請求

個人改造后的項目代碼在這里,您可以直接fork或者down下來使用。

2. 使用 markdown 搞定你的文章

2.1 用于新建文章的交互式命令行(基于 inquirer)

一般的靜態博客系統(如gatsby),會給用戶提供一個用于創建新文章的交互式命令行,效果大致如下:

readline

類似功能可以使用nodejs中readline模塊的原生方法來實現。這里推薦一個第三方工具:inquirer,本質上是對readline模塊進行了增強,提供了很多實用的方法用于交互式命令行開發,實現的用戶界面(命令行)也比較友好。

對于上面GIF示例的功能,其代碼實現如下:

// newPost.js

const inquirer = require('inquirer');
const moment = require('moment');

const questions = [
  {
    type: 'input',
    name: 'post_name',
    message: '請輸入您的文章別名(用于創建文章目錄,僅限英文,單詞間用短橫杠‘-’連接):',
    validate: value => {
      if (/(\.|\*|\?|\\|\/)/gi.test(value)) {
        return '文章別名不得包含特殊符號(.*?\\/),請重新輸入↑↑';
      }

      if (/(([A-z]+-)+)?[A-z]+/gi.test(value)) {
        return true;
      }

      return '文章別名不合法,請重新輸入↑↑';
    },
    filter: value => value.replace(/\s+/gi, '-'),
  },
  {
    type: 'input',
    name: 'create_at',
    message: '請輸入文章的發布時間(或者按回車鍵使用默認值):',
    default: () => {
      return moment().format('YYYY-MM-DDThh:mm:ss');
    },
    validate: value => {
      if (/\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d/gi.test(value)) {
        return true;
      }

      return '時間格式不合法,請重新輸入↑↑';
    },
  },
];

inquirer
  .prompt(questions)
  .then(answers => {
    // 獲取用戶輸入
    const { post_name, create_at } = answers;
  
    /* 此處做一些命令行反饋和過程性的工作 */
    /* (如:提示用戶輸入是否合法、創建文章對應的目錄和文件等等) */
  })
  .catch(err => {
    /* 異常處理 */
  });

如是,將此node腳本添加到項目package.jsonscripts中(如:new-post: "node newPost.js"),即可通過npm run命令執行。

2.2 md 轉 html(基于 react-markdown)

為使用markdown文檔來編輯、存儲博客的文章內容,需要將md文檔轉換為react的JSX對象以渲染到網頁中。在此推薦使用react-markdown,功能很6,作者維護得也比較勤。

使用方式如下:

import ReactMarkdown from 'react-markdown';

<ReactMarkdown source={'# 這是文章標題\n\n'} />
// <h1>這是文章標題</h1>

2.3 代碼塊的語法高亮

react-markdown提供了一個renderers屬性,用戶可以傳入一系列renderer組件來自定義文章中一些內容的渲染方式(有興趣的童鞋可以看下包作者對默認renderer的實現)。

如:自定義md中圖片的渲染方式(用法如下)。

// 傳入renderer的方式
<ReactMarkdown
  source={'[md文本內容]'}
  renderers={{
    image: ImageRenderer,
  }}
/>
// ImageRenderer的實現

import React, { Component } from 'react';
import PropTypes from 'prop-types';

class ImageRenderer extends Component {
  static propTypes = {
    src: PropTypes.string.isRequired,
  };

  render() {
    return (
      <img
        className="post-content-image"
        src={this.props.src}
        alt={this.props.src}
      />
    );
  }
}

export default ImageRenderer;

與此類似,我們可以通過傳入一個自定義的renderer來實現文章中代碼塊的語法高亮。名為CodeBlock的renderer實現如下:

import React, { Component } from 'react';
import PropTypes from 'prop-types';
import { highlight, languages } from 'prismjs';
import ReactHtmlParser from 'react-html-parser';
import 'prismjs/themes/prism.css';

export class HtmlComponent extends Component {
  static propTypes = {
    html: PropTypes.string.isRequired,
  };

  render() {
    return ReactHtmlParser(this.props.html);
  }
}

export class CodeBlock extends Component {
  static propTypes = {
    literal: PropTypes.string.isRequired,
    language: PropTypes.string.isRequired,
  };

  render() {
    const html = highlight(this.props.literal, languages[this.props.language]);
    const cls = `language-${this.props.language}`;

    return (
      <pre className={cls}>
        <code className={cls}>
          <HtmlComponent html={html} />
        </code>
      </pre>
    );
  }
}

export default CodeBlock;

此處用到了prismjsreact-html-parser兩個npm包,前者用于將代碼文本轉化為html文本,后者用于將html文本轉化為React的JSX對象以傳入React組件(這樣做比直接使用dangerouslySetInnerHTML屬性更安全些)。

3. 文章分類

一個友好的站點肯定少不了導航菜單(或文章的分類菜單),本人的實現方式是直接使用文章的“標簽”來進行分類統計,并生成站點的頂部導航,效果如下:

nav-top

為此,需要撰寫一定的腳本實現文章的分類統計和打包,個人的實現方式是將統計結果和文章內容各自打包為json文件,通過前端組件請求數據并加載。

導航欄組件的具體實現如下:

import React, { Component } from 'react';
import PropTypes from 'prop-types';
import { Link } from 'react-router-dom';
import { Dropdown, Menu, Icon } from 'antd';
import { randomId } from 'utils';
import './style.css';

export class Header extends Component {
  static propTypes = {
    data: PropTypes.array,
    activeTag: PropTypes.string,
  };

  static defaultProps = {
    data: [{ tag: '前端', count: 5 }],
    activeTag: '',
  };

  constructor(props) {
    super(props);
    this.navTotal = 6;
  }

  renderMore() {
    if (this.props.data.length <= this.navTotal) {
      return false;
    }

    const subNavItems = this.props.data.slice(this.navTotal).map(t =>
      <Menu.Item key={`sub_nav_${randomId()}`}>
        <Link
          to={t.linkTo || `/tag/${t.tag}`}
          className={`ant-dropdown-link ${this.props.activeTag === t.tag
            ? 'active'
            : ''}`}
          key={`nav_top_${randomId()}`}>
          {t.tag}({t.count})
        </Link>
      </Menu.Item>
    );

    const SubNav = (
      <Menu>
        {subNavItems}
      </Menu>
    );

    const DropDownBtn = (
      <Dropdown overlay={SubNav} key={`nav_top_${randomId()}`}>
        <div className="header-nav-item">
          更多分類 <Icon type="down" />
        </div>
      </Dropdown>
    );

    return DropDownBtn;
  }

  renderTop5() {
    const items = this.props.data.slice(0, this.navTotal - 1).map(t =>
      <Link
        className={`header-nav-item ${this.props.activeTag === t.tag
          ? 'active'
          : ''}`}
        to={t.linkTo || `/tag/${t.tag}`}
        key={`nav_top_${randomId()}`}>
        {!t.linkTo ? `${t.tag}(${t.count})` : t.tag}
      </Link>
    );

    return (
      <div className="header-nav">
        {items}
        {this.renderMore()}
      </div>
    );
  }

  render = () => this.renderTop5();
}

export default Header;

大家可以根據實際需要實現自己的文章打包方式(這里就不奉上我的腳本了??)。

4. 更多功能

對于個人博客來說,到這里為止還有很多功能沒有實現,這里偷個懶,奉上一些相關的鏈接吧:

4.1 關于文章評論

4.2 關于文章結構樹

我最近應該會實現一個React用途的markdown樹組件,大家不妨期待下??

5. 發布你的個人靜態站點

5.1 部署到 github pages(基于 gh-pages)

CRA針對github pages用途專門推薦了一個包:gh-pages,使用方法如下:

(1)修改項目的package.json文件,添加homepage屬性:

"homepage": "https://parksben.github.io",

(2)項目安裝gh-pages依賴后修改,在package.json中添加如下配置:

  "scripts": {
+   "predeploy": "npm run build",
+   "deploy": "gh-pages -d build",
    "start": "react-scripts start",
    "build": "react-scripts build",

(3)將本地代碼上傳到github博客倉庫的某個分支(只要不是master分支就行),然后執行:

yarn deploy

gh-pages會將CRA項目build到倉庫的master分支,然后,你就可以訪問你的站點了(有關 CRA 項目部署到 github pages 的詳細描述可以看這里)。

5.2 如何兼容 React 的客戶端路由(一種比較 hack 的方法)

單頁面應用一般需要設置服務端路由,將應用的所有頁面路徑都重定向到index.html,而github pages并沒有這樣的默認設置。

因而,當你使用React的客戶端路由(React的createBrowserHistory方法創建前端路由)時,除根路徑以外的頁面,github都會返回自己的404頁面。

為此,CRA項目提供了一種比較hack的方法來支持React的客戶端路由(通過操作window.history來強行匹配url)。也算是一種奇技淫巧吧??。

(1)在CRA項目的public目錄下添加一個404.html,其內容如下:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>矮大緊的日常 | parksben's blog</title>
    <script type="text/javascript">
      var segmentCount = 0;
      var l = window.location;
      l.replace(
        l.protocol + '//' + l.hostname + (l.port ? ':' + l.port : '') +
        l.pathname.split('/').slice(0, 1 + segmentCount).join('/') + '/?p=/' +
        l.pathname.slice(1).split('/').slice(segmentCount).join('/').replace(/&/g, '~and~') +
        (l.search ? '&q=' + l.search.slice(1).replace(/&/g, '~and~') : '') +
        l.hash
      );
    </script>
  </head>
  <body>
  </body>
</html>

(2)在index.html的head中添加如下代碼:

<script type="text/javascript">
  (function(l) {
    if (l.search) {
      var q = {};
      l.search.slice(1).split('&').forEach(function(v) {
        var a = v.split('=');
        q[a[0]] = a.slice(1).join('=').replace(/~and~/g, '&');
      });
      if (q.p !== undefined) {
        window.history.replaceState(null, null,
          l.pathname.slice(0, -1) + (q.p || '') +
          (q.q ? ('?' + q.q) : '') +
          l.hash
        );
      }
    }
  }(window.location))
</script>

大功告成,你的github站點支持React的客戶端路由了。

除此之外,也可以改為使用createHashHistory方法來創建客戶端路由,這樣前端路由就與服務端路由沒多大關系了,不過url里面一串hash畢竟不夠優雅。

有興趣了解奇技淫巧的童鞋,可以點這里

5.3 部署到自己的服務

與CRA項目的生產環境部署方式一樣:

  • 線上執行 yarn build 命令,站點的所有靜態資源將打包到 build 目錄下
  • 將你的站點的入口配置到 build 目錄下

6. 項目參考(源碼奉上)

parksben.github.io

這是我的github博客(基于上述過程實現的靜態站點),感興趣的伙伴可以點擊這里查看項目源碼,覺得有用也可以fork或star一下下。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,401評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,011評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,263評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,543評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,323評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,874評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,968評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,095評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,605評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,551評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,720評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,242評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,961評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,358評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,612評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,330評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,690評論 2 370

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,582評論 25 707
  • Swift版本點擊這里歡迎加入QQ群交流: 594119878最新更新日期:18-09-17 About A cu...
    ylgwhyh閱讀 25,467評論 7 249
  • 同樣是做事,有人順風順水,有人效率低下。 例如同在銷售部門,有人每月收入頗豐,有人僅夠溫飽,因為對時間的態度不...
    斐麗希婭閱讀 144評論 0 0
  • 北京時間2017年3月22日武漢江夏公司李倩 導語:從昨天一天補聽鯤鵬大哥的分享,以及今日聽了舒月姐的分享,總有一...
    叁櫟閱讀 189評論 0 0
  • “舉杯邀明月,對影成三人。”明月空照,影徒隨身,你還是孤獨的。也就是這孤獨成就了你精彩的一生。 “仰...
    幸存者XCZ閱讀 171評論 0 0