2024-04-11 | Jupyter Book & Github Pages--撰寫網(wǎng)頁書

在我們學(xué)習(xí)某些東西的時候纷责,經(jīng)常會用pdfmarkdown文件或者ipynb文件等去記錄一些分析過程臣樱,但是如果文件比較多并且比較長的時候靶擦,后面查閱起來會很麻煩。因此雇毫,想著用Jupyter Book這一工具將他們轉(zhuǎn)成網(wǎng)頁書的形式玄捕,方便閱讀

1 軟件安裝

# 直接使用pip進(jìn)行安裝就行了
pip install jupyter-book

2 使用

1初始化項(xiàng)目結(jié)構(gòu)

jupyter-book create mybook/

2組織內(nèi)容

將你的 Jupyter Notebook (.ipynb)Markdown (.md) 文件以及其他支持的文檔放入 mybook/content/ 目錄下棚放,一般這個目錄自己創(chuàng)建就行了枚粘,確保放入前是個空目錄

3 配置書本

修改 mybook/_config.yml文件,以配置書本的標(biāo)題飘蚯、作者馍迄、語言、主題以及其他高級選項(xiàng)局骤。

title: "My R Learning Book"
author: "Lulu Shi"

baseurl: "https://crazzy-rabbit.github.io/Rscript-to-anaylise-and-visualize/"
repository:
   url : "https://github.com/crazzy-rabbit/Rscript-to-anaylise-and-visualize" 

#######################################################################################
sphinx:
  config:
    source_suffix:
      - .ipynb

#######################################################################################
# Execution settings
execute:
  execute_notebooks         : auto  # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off")
  cache                     : ""    # A path to the jupyter cache that will be used to store execution artifacts. Defaults to `_build/.jupyter_cache/`
  exclude_patterns          : []    # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time)
  timeout                   : 30    # The maximum time (in seconds) each notebook cell is allowed to run.
  run_in_temp               : false # If `True`, then a temporary directory will be created and used as the command working directory (cwd),
                                    # otherwise the notebook's parent directory will be the cwd.
  allow_errors              : false # If `False`, when a code cell raises an error the execution is stopped, otherwise all cells are always run.
  stderr_output             : show  # One of 'show', 'remove', 'remove-warn', 'warn', 'error', 'severe'

修改 mybook/_toc.yml文件攀圈,以配置書本的章節(jié)

# Table of contents
# Learn more at https://jupyterbook.org/customize/toc.html

format: jb-book
root: intro
chapters:
  - file: "content/R語言學(xué)習(xí)1-語法函數(shù)1-基礎(chǔ)介紹.ipynb"
  - file: "content/R語言學(xué)習(xí)2-語法函數(shù)2-數(shù)據(jù)處理dplyr包.ipynb"
  - file: "content/R語言學(xué)習(xí)3-語法函數(shù)3-正則表達(dá)式-stringr包.ipynb"
  - file: "content/R語言學(xué)習(xí)4-語法函數(shù)4-因子型變量_數(shù)據(jù)框_函數(shù)式編程purrr包.ipynb"
  - file: "content/R語言學(xué)習(xí)5-數(shù)據(jù)可視化-ggplot入門.ipynb"
  - file: "content/R語言學(xué)習(xí)6-數(shù)據(jù)可視化-ggplot進(jìn)階(1)之各種圖的實(shí)現(xiàn).ipynb"
  - file: "content/R語言學(xué)習(xí)7-數(shù)據(jù)可視化-ggplot進(jìn)階(2)之標(biāo)度scale相關(guān)語法.ipynb"
  - file: "content/R語言學(xué)習(xí)8-數(shù)據(jù)可視化-ggplot進(jìn)階(3)之主題設(shè)置theme語法.ipynb"
  - file: "content/R語言學(xué)習(xí)9-數(shù)據(jù)可視化-ggplot進(jìn)階(4)之圖例系統(tǒng).ipynb"
  - file: "content/R語言學(xué)習(xí)10-數(shù)據(jù)可視化-ggplot進(jìn)階(5)之?dāng)U展內(nèi)容.ipynb"
  - file: "content/R語言學(xué)習(xí)11-數(shù)據(jù)可視化-ggplot進(jìn)階(6)之統(tǒng)計(jì)圖層.ipynb"

5 構(gòu)建書本

jupyter-book build -W -n --keep-going --all .

# .表示當(dāng)前目錄為mybook/
# --all表示重新構(gòu)建所有

生成的文件在_build/文件夾下,而發(fā)布書時峦甩,只需要_build/html文件夾下的內(nèi)容

6 發(fā)布到Github Pages

_build/html 目錄下的內(nèi)容(不包括這個目錄本身)上傳到 GitHub 新建的reposiory中赘来,點(diǎn)擊settings,后選擇pages凯傲,然后進(jìn)行分支的選擇(如果是新建的reposiory犬辰,則選擇main\root

注意!1ァ忧风!在 main\root目錄下需要添加.nojekyll 文件空文件:

  • 由于 GitHub Pages 默認(rèn)使用 Jekyll 來構(gòu)建網(wǎng)站,
  • Jupyter Book 生成的靜態(tài)網(wǎng)站可能不符合 Jekyll 的要求球凰,
  • 因此需要在 分支的根目錄下添加一個名為 .nojekyll 的空文件狮腿。這樣可以告訴 GitHub Pages 不要使用 Jekyll 來構(gòu)建您的網(wǎng)站腿宰。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市缘厢,隨后出現(xiàn)的幾起案子吃度,更是在濱河造成了極大的恐慌,老刑警劉巖贴硫,帶你破解...
    沈念sama閱讀 206,126評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件椿每,死亡現(xiàn)場離奇詭異,居然都是意外死亡英遭,警方通過查閱死者的電腦和手機(jī)间护,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來挖诸,“玉大人汁尺,你說我怎么就攤上這事《嗦桑” “怎么了痴突?”我有些...
    開封第一講書人閱讀 152,445評論 0 341
  • 文/不壞的土叔 我叫張陵,是天一觀的道長狼荞。 經(jīng)常有香客問我辽装,道長,這世上最難降的妖魔是什么相味? 我笑而不...
    開封第一講書人閱讀 55,185評論 1 278
  • 正文 為了忘掉前任拾积,我火速辦了婚禮,結(jié)果婚禮上丰涉,老公的妹妹穿的比我還像新娘殷勘。我一直安慰自己,他們只是感情好昔搂,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,178評論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著输拇,像睡著了一般摘符。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上策吠,一...
    開封第一講書人閱讀 48,970評論 1 284
  • 那天逛裤,我揣著相機(jī)與錄音,去河邊找鬼猴抹。 笑死带族,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蟀给。 我是一名探鬼主播蝙砌,決...
    沈念sama閱讀 38,276評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼阳堕,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了择克?” 一聲冷哼從身側(cè)響起恬总,我...
    開封第一講書人閱讀 36,927評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎肚邢,沒想到半個月后壹堰,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,400評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡骡湖,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,883評論 2 323
  • 正文 我和宋清朗相戀三年贱纠,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片响蕴。...
    茶點(diǎn)故事閱讀 37,997評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡谆焊,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出换途,到底是詐尸還是另有隱情懊渡,我是刑警寧澤,帶...
    沈念sama閱讀 33,646評論 4 322
  • 正文 年R本政府宣布军拟,位于F島的核電站剃执,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏懈息。R本人自食惡果不足惜肾档,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,213評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望辫继。 院中可真熱鬧怒见,春花似錦、人聲如沸姑宽。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽炮车。三九已至舵变,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間瘦穆,已是汗流浹背纪隙。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評論 1 260
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留扛或,地道東北人绵咱。 一個月前我還...
    沈念sama閱讀 45,423評論 2 352
  • 正文 我出身青樓,卻偏偏與公主長得像熙兔,于是被迫代替她去往敵國和親悲伶。 傳聞我的和親對象是個殘疾皇子艾恼,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,722評論 2 345

推薦閱讀更多精彩內(nèi)容