小書匠使用手冊
小書匠編輯器使用手冊
小書匠使用手冊概要
小書匠編輯器是一款專為markdown寫作而設計的編輯器。
主要功能
- 專為markdown寫作設計的文檔編輯器,讓用戶心無旁騖的進行創作。
- 多種編輯模式。單欄編輯,雙欄編輯,三欄編輯,全屏寫作,全屏閱讀...想怎麽切換,就怎麽切換,就是這樣隨心所欲。
- 多種編輯器實現。codemirror編輯器(提供vim,emacs按鍵,行專註等),ace編輯器(提供vim,emacs按鍵綁定,顯示行號),輕量編輯器,CJK豎排編輯器
- 多種主題選擇。包括編輯器主題,預覽區代碼高亮主題,及預覽區用戶自定義css。
- 豐富的語法支持。不僅提供了常用的commanmarkdown語法,還提供了許多有用的擴展語法,比如Latex公式
- 代碼塊文字格式語法。語法可查看<小書匠語法使用手冊>
- 第三方同步。瀏覽器存儲, 本地文件系統存儲, dropbox, evernote, 印象筆記,有道筆記, 為知筆記, github等多種存儲方案,保證了用戶數據的安全,也讓用戶在存儲方案上有了更多的選擇。
- 支持evernote,印象筆記。提供雙向操作,可以將文章保存到evernote/印象筆記上,也可以從evernote/印象筆記上導入數據。同時提供標簽,附件,圖片,待辦等相關處理。
- 強大的文件管理功能
- 發布功能。 支持將文章發布到博客平臺上。
- 郵件發送功能。
- sourceMap對照功能。方便在源markdown文件和生成的html文件上進行比較,特別適合markdown初學者使用,了解每一個markdown解析產生的結果,也適用於文章後期的校對上。
- ppt。
- ppt跨屏演示
- pdf預覽
- typewriter scrolling
- autocomplete 和 snippets 功能
離線版下載地址
http://soft.xiaoshujiang.com
WEB版訪問地址
http://markdown.xiaoshujiang.com
元數據使用說明
語法開關元數據項,可以到設置面板裏的語法擴展標簽頁下查看對應的元數據標識.在元數據裏true時,表示當前文檔強制打開該語法,false時表示強制關閉該語法.如果沒有對應的元數據,則使用全局設置裏的語法開關.
preview_previewType
元數據,可用的值為normal
和presentation
.用於文章在打開時,控制是否需要系統切換對應的預覽界面.如果文章裏沒有該項元數據,或者元數據值不正確,則系統默認使用normal
預覽界面.該元數據僅控制文章打開時初始化的界面,用戶依然可以通過按鈕在不同預覽界面間切換.
瀏覽器存儲
系統對創建的文章,都會在瀏覽器存儲上進行保存。包括像evernote/印象筆記/github/dropbox等導入的文章,也都會保存一份副本,並創建一個標識,表示跟哪些第三方存儲關聯。
標題,標簽
文章標題的處理規則:如果文章內存在元數據title,則系統自動使用元數據內的title做為標題。如果文章未使用到元數據功能,用戶可以通過維護文章信息按鈕,修改標題。標簽tags的規則也跟標題一樣。
附件
文章使用./
做為附件的引用標識。對於圖片
,音頻
,視頻
,附件
等鏈接的處理,系統只處理以./
開頭的鏈接,並轉換成附件真實的地址進行顯示。用戶可以通過工具欄的插入圖片
,插入音頻
,插入視頻
,插入附件
等按鈕上傳附件。
evernote/印象筆記
小書匠編輯器提供對evernote/印象筆記的支持,下面的使用說明默認用戶已經完成了evernote/印象筆記的綁定操作,並將當前的工作平臺切換到evernote/印象筆記下。
新建
通過新建按鈕後,創建的文章將自動關聯到evernote/印象筆記上(註:這裏僅僅是在文章上創建一個關聯的標識,只有當用戶保存後,才能在服務器上查看到新的筆記)
打開
點擊筆記,系統將自動把筆記導入,並將當前文章切換為導入的筆記內容。導入的文章自動與evernote/印象筆記上的筆記關聯,下次再點擊該筆記時,將直接從瀏覽器存儲上打開。用戶可以通過切換存儲平臺瀏覽器存儲
,來刪除該緩存的文件。導入的筆記如果本地沒有緩存,系統將對服務器上的筆記進行判斷,如果筆記是通過小書匠編輯器進行保存,並且文章在保存後沒有被操作過,則系統自動使用保存時附帶的markdown附件做為文章內容,重新導入。如果筆記已經被修改,或者筆記不是通過小書匠編輯器進行保存的,系統將自動將文章轉換成markdown格式。
保存
對於新創建的文章,用戶可以直接保存ctrl+s
,系統將彈出一個選擇筆記本的窗口,確認後,系統將保存當前文章到evernote/印象筆記上。(在彈出窗口上選擇筆記本時,如果用戶選擇了筆記,系統將覆蓋該筆記)
對於已經存在的文章,但還沒有保存到evernote/印象筆記,用戶可以通過另存為ctrl+shift+s
將當前文章保存到evernote/印象筆記上。
不管是保存,還是另存為,保存成功後,系統都將自動對當前文章與evernote/印象筆記上的筆記進行關聯。下次保存時ctrl+s
系統將自動同步保存到evernote/印象筆記上。
刪除
系統不提供刪除操作,用戶需要自己到evernote/印象筆記端刪除,如果本地緩存了筆記,可以通過瀏覽器存儲
刪除緩存。
重命名
直接修改元數據title,如果文章內未使用元數據功能,可通過瀏覽器存儲
裏的修改文章信息進行修改
標簽管理
系統自動通過每篇文章的元數據tags
提取為筆記的標簽。
附件管理
打開時,系統自動將筆記上的附件導入到文章對應的附件管理器上。保存時,系統將根據文章內對附件的引用,將附件保存到服務器上。這裏的引用包括音頻
,視頻
,附件
,圖片
。如果文章內使用到了流程圖
,序列圖
,公式
,統計圖
等,系統將會把這些內容轉換成圖片進行保存。由於evernote/印象筆記在部分終端不提供視頻,音頻的支持,查看保存的文章時,對應的音頻,視頻將以附件的形式存儲。
待辦事項
目前系統僅同步了待辦事項。
github/dropbox
新建
參考evernote/印象筆記
的新建
打開
參考evernote/印象筆記
的打開
不同的是,github/dropbox只能打開擴展名為html
,markdown
,md
,mkd
以及無擴展名的文件。
保存
參考evernote/印象筆記
的保存
不同的是,github/dropbox保存時,僅保存了markdown文章本身,並不會將markdown轉換成html進行保存,也不會處理附件相關的內容。
對於新文章的保存,github/dropbox存儲需要用戶指定文件名及存儲的位置。
刪除
系統不提供刪除操作
重命名
系統不提供重命名操作,只能通過另存為ctrl+shift+s
,保存成新的文件。
本地文件系統存儲
本地文件系統存儲僅在離線版提供支持。
新建
參考evernote/印象筆記
的新建
打開
參考github/dropbox
的打開
不同的是,本地文件系統存儲在打開文件時,將會自動關聯文章內的附件引用標識./
,自動抓取同級目錄下對應的附件資源。
保存
參考github/dropbox
的保存
不同的是,本地文件系統存儲在保存時,不僅保存了markdown文章,還會處理附件相關的內容,將附件保存到同級目錄下,請確保附件的名稱不要重復,防止數據被覆蓋丟失。
刪除
右擊相應的文章可進行刪除操作
重命名
右擊相應的文章可進行重命名操作
發布
小書匠編輯器離線版提供文章發布功能,用戶可以將自己的文章發布到博客系統上。發布功能實現了博客的metaweblogAPI(newPost, editPost, newMediaObject)。使用該發布功能,需要博客系統提供對應的api接口,系統將轉換成html的文章和圖片自動提交到博客系統上。
配置發布示例:
博客鏈接地址:比如http://www.cnblogs.com/[用戶名]/
用戶名:用戶在該博客上的用戶名
密碼:用戶在該博客上的密碼
測試通過的博客地址:
博客園:http://www.cnblogs.com/[用戶名]/
開源中國:http://my.oschina.net/[用戶名]/blog
郵件發送
小書匠編輯器提供郵件發送功能,系統將對當前文章轉換成html格式後進行發送,並對圖片,視頻等文件以附件的形式進行發送。
導出
小書匠編輯器提供多種格式的導出文件功能。html,markdown,html(inlinestyle),word,zip,pdf。
zip導出: 該導出將導出文章的所有信息,包括markdown,html,markdown文章內引用的所有附件,公式,流程圖等對應的圖片文件,以及方便再次導入時需要的標識數據文件。
pdf導出:目前pdf導出只能在chrome版瀏覽器上使用。
導入
小書匠編輯器提供markdown, html, zip三種導入功能,並且實現了文本文件直接拖動導入功能。
zip導入:導入的zip文件必需是由小書匠編輯器導出的文件。
其他
web版實現了圖片直接粘貼功能,用戶不僅可以拖動圖片上傳,還可以直接復制粘貼圖片。
小書匠使用手冊