簡述

寫這個工具主要目的在於減少工作量，bear在寫gitbook的時候，發現對應目錄一個一個寫進去，非常繁瑣，而且最近在學習python，所以，手癢之下寫了一個目錄生成的小工具。

工具使用

本身工具並不複雜，主要實現功能接受一個github中的raw版本的url，然後列印自動生成對應文件的markdown語法的目錄。

• 第一步
  點擊對應github中目標文件raw的按鈕。
  

• 第二步
  獲取原始的markdown文件，複製對應url。
  

• 第三步
  獲取工具，同第一步，可以使用wget工具從github上獲取源代碼。
  

• 第四步
  運行。（具體操作，也可以看代碼註釋說明）
  

模塊設計

本身工具比較簡單，主要涉及的功能是：

1. 利用http協議從url中獲取github文件；
   通過python提供的urllib2庫，可以直接獲取github上的文件。
2. 從文件中提取目錄信息。
   根據markdown語法，目錄是帶“#”，目錄內容空格間隔。
   ps:其中，較為繁瑣的是，目錄中如果出現“!@#$”等字元，github有特定的轉換語法（bear是一個個試出來的，函數valueToUrl），此外，還有相同目錄內容的情況，也會有處理（函數 getSameContentNum）。
3. 將目錄信息轉化為最終目錄的語法。
   同樣也是根據markdown語法。

結束語

由於第一次寫工具，如有不當的地方，或者程式有bug，請指出，不勝感激。