2023-11-26 11:46 AM 7 10,962
學會 Markdown 後愈來愈不愛開 Word,習慣 CLI 後愈來愈不想滑滑鼠,是我這些年的寫照。 我除了 Blog 用 Markdown 寫,技術相關文件也試著改用 Markdown 寫,VSCode 配合相關套件,基本上的功能已能滿足,畢竟技術文件的核心在於文字、圖例本體,使用 VSCode...
2023-02-04 08:13 AM 1 12,359
嘗試用 Markdown 取代 Word 寫零散文件,但交付對象只接受 Word 或 PDF 格式,我需要一個方便(而且最好免費)的 Markdown 轉 PDF 工具,找到一個好用的 VSCode 擴充套件 - Markdown PDF,省下自己造輪子的工夫。 官方說明文件頗詳細,很容易上手,在...
2022-07-02 10:24 PM 0 2,293
前陣子試了在 ASP.NET Core 網站即時顯示 Markdown 文件,如此可用 Visual Studio 寫 Markdown,跟網站一併部署就直接轉網頁,不用依賴 Hugo 之類的第三方工具,對線上說明之類的網站附屬文件挺方便。順著這個概念繼續擴充,我還想自動產生文件清單,用來管理公告、...
2022-06-22 06:15 PM 5 3,408
前幾天介紹過在 Visual Studio 寫 Markdown 文件的好用擴充套件 - Markdown Editor,我有個大膽的想法:既然在 VS 寫 Markdown 這麼方便,我何不在 ASP.NET Core 網站開個專屬資料夾直接寫線上使用手冊,像這樣: 像上面這樣,Markdown...
2022-06-20 10:04 PM 0 8,743
先前提過我打算用 Markdown 寫技術文件,當時的研究以 VSCode + Hugo 為主,配合 VSCode Paste Image 套件,可以複製貼上畫面擷圖,Hugo 還能自動產生文章清單及章節目錄,要應付結構稍複雜的文件也行。(有不少書籍作者已改用 Markdown 寫作,應不用太擔心其...
2022-01-15 08:08 PM 2 3,558
對於長篇文件,提供章節目錄讓讀者能快速跳到所需內容是貼心設計,若是網頁,我們可以在章節標題加上 <h2 id="fragmentName">...</h2> 搭配 <a href="#fragmentName">...<...
2022-01-14 09:24 PM 0 2,594
這篇介紹一個 Hugo / Markdown VSCode 擴充套件 - Front Matter (套件名稱跟 Front Matter 撞名是不利 SEO 的失敗決定,跟 GO 語言一樣很不好爬文),它的功能很多,我只用到少少幾項,但已大幅提升編輯文件的流暢性。 安裝好 Front Matter...
2022-01-10 09:09 PM 0 2,157
在 Hugo 中關聯文件的方式有兩種,對於有結構性的固定內容,可以自己在 Markdown 寫連結,例如: 關於詳細步驟,請參考[安裝章節](/install/)的說明。 另一種是偏條列式,項目會隨時間移減的項目,則由 Hugo 自動產生清單是較省事的做法。在前一篇的範例,faq 加入 _inde...
2022-01-07 11:13 PM 4 5,948
先說一下,這系列文章將聚焦於用 VSCode 搭配 Hugo 以 Markdown 格式撰寫 KB、操作手冊、系統文件... 等技術文件,性質與用法會與部落格文章有點差距,例如:較少用到最新文章、草稿狀態、發佈時間排序、分類/標籤... 等功能,如果你的目的是用 Hugo 寫部落格,可以參考 20...
2022-01-05 11:01 PM 12 15,912
我在三年前改用 Markdown 寫部落格,著眼點在省去改樣式、設連結、調位置... 等無謂的排版工夫,全力專注在文字內容上(謎:那錯字還那麼多是為什麼?),額外收獲是學會寫 Markdown 的技能。Markdown 無疑是當今技術寫作的主流格式,如 Github、Stackoverflow 都以...
2018-10-10 11:37 AM 10 8,249
這回更換部落格平台,背後我還做了另一項大改變 - 改用 Markdown 寫文章。 為什麼要用 Markdown 隨著 Github/Stackoverflow 大量採用 Markdown 作為技術文件、討論區的撰寫格式,這些年寫 Markdown 已成為開發者參與技術社群的必備技能,甚至許多技術作...