GitHub與Markdown(學習筆記)

2022-06-21 09:48:11 字數 3027 閱讀 4732

一、學前提問:

1.github用fq嗎?

訪問 github 不用fq,只是可能訪問速度稍慢些。

2.英語差學得會嗎?

github 雖然都是英文,但是,對英語水平的要求不是那麼高,都是些簡單的單詞,遇到不會的查一下。

二、進入學習:

1.註冊賬號(sign up)

官網:沒啥好說的,需要填使用者名稱、郵箱、密碼。

使用者名稱就是你以後常用的使用者名稱了,也建議你各大社交賬號都用一樣的使用者名稱,這樣識別度較高,而且這個使用者名稱以後在 github 搭建部落格的時候,預設給你生成的部落格位址就是 。

填好使用者名稱、郵箱、密碼緊接著到這一步:

這個是什麼意思呢?

github 有兩種:

一種是公開,這種是免費的,就是你建立的專案是開放的,所有人都能看得到;

另一種是私有,這種是收費的,這種一般是很多企業在使用 github 的私有倉庫在託管自己的專案,這也是 github 的一種盈利模式對於個人你就直接預設選擇公開的就行了。

timeline,這部分你可以理解成微博,就是你關注的一些人的活動會出現在這裡。

三、github主頁

點選 your profile 選單進入到你的個人 github 主頁。

我的賬號剛建立沒多久,內容不豐富。下圖來自於網路:

四、設定你的github

點選settings 選單:

設定基本資訊:

五、github基本概念

了解一些 github 的基本概念,這些概念是經常會接觸並遇到的。

1)repository(倉庫)

你想在 github 上開源乙個專案,那就必須要新建乙個 repository ,如果你開源的專案多了,你就擁有了多個 repositories 。

2)issue(問題)

比如,開源了乙個專案,別人發現你的專案中有bug,或者哪些地方做的不夠好,他就可以給你提個 issue ,即問題,提的問題多了,也就是 issues ,然後你看到了這些問題就可以去逐個修復,修復ok了就可以乙個個的 close 掉。

3)star(星星)

4)fork

比如,你開源了乙個專案,別人想在你這個專案的基礎上做些改進,然後應用到自己的專案中,這個時候他就可以 fork 你的專案,這個時候他的 github 主頁上就多了乙個專案,只不過這個專案是基於你的專案基礎(本質是在原有專案的基礎上新建了乙個分支,回憶前面git內容),他就可以隨心所欲的去改進,但是絲毫不會影響原有專案的**與結構。

5)pull request(發起請求)

這個其實是基於 fork 的,還是上面那個例子,如果別人在你基礎上做了改進,後來覺得改進的很不錯,應該要把這些改進讓更多的人收益,於是就想把自己的改進合併到原有專案裡,這個時候他就可以發起乙個 pull request(簡稱pr) ,原有專案建立人就可以收到這個請求,這個時候他會仔細review你的**,並且測試覺得ok了,就會接受你的pr,這個時候你做的改進原有專案就會擁有了。

6)watch(觀察)

如果你 watch 了某個專案,那麼以後只要這個專案有任何更新,你都會第一時間收到關於這個專案的通知提醒。

7)gist

有些時候你沒有專案可以開源,只是單純的想分享一些**片段,那這個時候 gist 就派上用場了!

六、建立自己的專案

我的git篇有提到的。

如下圖:

建立乙個專案需要填寫如上的幾部分:

專案名、專案描述與簡單的介紹,你不付費沒法選擇私有的,所以接著只能選擇 public 的,之後勾選「initialize this repository with a readme」,這樣你就擁有了你的第乙個 github 專案:

** readme.md 介紹:

github 上所有關於專案的詳細介紹以及 wiki 都是基於 markdown 的,甚至之後在 github 上搭建部落格,寫部落格也是如此,所以如果還不懂 markdown 語法的,建議先去學習下。

七、markdown學習

markdown具有一系列衍生版本,用於擴充套件markdown的功能(如**、腳注、內嵌html等等),markdown增強版中比較有名的有markdown extra、multimarkdown、 maruku等。這些衍生版本要麼基於工具,如pandoc;要麼基於**,如github和wikipedia,在語法上基本相容,但在一些語法和渲染效果上有改動。

世界上最流行的部落格平台wordpress和大型cms如joomla、drupal都能很好的支援markdown。完全採用markdown編輯器的部落格平台有ghost和typecho。

用於編寫說明文件,並且以「readme.md」的檔名儲存在軟體的目錄下面。

**學習之旅:

github與markdown使用總結

初次接觸github是在師兄的介紹下,註冊完成github賬戶之後,給我的感覺是困難重重,一方面是英文,另一方面是看到的是大量的原始碼,不知從何下手。但是萬事開頭難,經過一段時間的摸索後,漸漸的熟悉了。故在此簡單介紹下github。另外還有markdown編輯器。如今的軟體開發不僅是 編寫,而且也包...

github的markdown特有語法

本文僅介紹 github 所支援的特有語法。以下顯示和渲染會因為各個 markdown 渲染器不同會導致顯示差異。請到 github 上檢視實際效果。words 渲染效果 刪除線可以在首段的 後填寫語言名稱。c printf hello n 渲染效果 printf hello n some word...

認識與入門 Markdown

markdown 是一種輕量級的 標記語言 它的優點很多,目前也被越來越多的寫 好者,撰稿者廣泛使用。看到這裡請不要被 標記 語言 所迷惑,markdown 的語法十分簡單。常用的標記符號也不超過十個,這種相對於更為複雜的html 標記語言來說,markdown 可謂是十分輕量的,學習成本也不需要太...