軟體工程師使用markdown寫文件的正確姿勢

2021-09-17 03:53:27 字數 1604 閱讀 9285

自從我在github上了解到markdown以後, 對markdown越來越愛不釋手. 從最開始的工程readme, 到個人部落格, 再到專案中的各種技術文件, 我都開始使用markdown來編寫.

工程中很多需要輸入文字的地方都可以引入markdown, 以github為列:

以上為netflix開源專案 hystrix 的readme.

專案logo, 專案簡介, wiki入口, **** 一應俱全. 這個排版很簡潔明瞭, 值得借鑑.

github的編輯器預設語法就是markdown, 使用wiki更能支援版本比較的功能.

而其他主流的wiki系統也都加入了支援markdown的外掛程式(比如xwiki,confluence).

既然markdown都玩這麼熟了, 再用markdown寫寫部落格吧.

目前主流的技術部落格系統都支援了markdown編輯器編寫文章(segmentfault, oschina 甚至元老級的csdn也支援了).

優點: 使用簡單. 前端工程師借助於atom, 編輯效率極高.

缺點: 啟動速度稍慢, 編輯框無法與預覽框同步滾動.

優點: 使用簡單, 對於後端工程師編輯效率高.

缺點: 啟動速度比較慢

優點: 啟動速度快, 所見即所得, 對於小白使用者友好.

缺點: 對於編輯功能與預覽功能不能分開.

萬能的pandoc可以支援多種格式文字檔案相互轉換. 但格式上可能會丟失較多的樣式(比如**語法沒有正確的轉換), 實際工作中使用較少.

saas服務

typora

typora提供了乙個非常簡單的word到markdown轉換方式: 在typora的預覽模式下, 全選word內容並複製進來, 內容就會自動轉成mardown格式, 這個功能做的非常棒.

atom通過外掛程式支援pdf的匯出, 但不支援目錄的生成, 但功能較弱.

而typora支援匯出為pdf的功能, 且支援目錄的生成, 還支援多種主題,更為人性化.

有了流行的標準markdown, 再加上便利的編輯工具typora, 在我的推廣下, 同事們逐漸接受了這種文件編寫方式, 並開始大規模在專案中使用.

軟體工程師招聘需求

我們又很多軟體工程師需求,有意向的和我聯絡 c 高階工程師 任職要求 1.大學本科及以上學歷,計算機相關專業畢業 2.良好的英語閱讀能力 學習能力 溝通能力及團隊協作精神,能夠承受一定工作壓力 3.紮實的 c 程式設計功底,精通 win32 mfc 和多執行緒等技術 4.五年以上 visual c ...

軟體工程師應該寫作

在小學,有一些 數學天才 和 語文天才 你們由於在其他孩子印象中各自的強項而被貼上標籤。我曾是乙個所謂的 數學天才 所以我主修電腦科學並嚮往去做乙個軟體工程師。雖然一直以來 數學天才 或 語文天才 這樣的稱號從來沒有真正的磨去,但只要可以把任何事做強。如今我見過的工程師畏懼寫東西,我見過的作家也同樣...

小白軟體工程師歷程

將自己作為乙個無知的海綿,去吸收更多的知識來充實自我。不知不覺,已經畢業三年,工作三年了。趁著難得空閒時間,對自己的工作好好進行下梳理。大學畢業,進入一家相對規模不錯的公司入職,進入到乙個雲集了各種大神的部門。還記得剛剛到達時候的各種恐慌,因為周圍的同事太強悍,每個人都是那麼的優秀,那麼的獨擋一面。...