Omi應用md2site發佈-markdown轉網站利器

寫在前面

Md2site是基於Omi的一款Markdown轉網站工具,使用簡單,生成的文件輕巧,功能強大。
當咱們想把一堆markdown文檔轉成網站時,你可能有許多選擇,假若選擇 md2site ,你必定會愛上她。html

特性

  • 超輕巧,生成的網站除了Omi不依賴其餘第三方庫,超級小的尺寸讓你加載更快
  • 完整支持Markdown,使用markdown寫你的文檔或者網站,完整支持markdown全部語法
  • 響應式,生成的網站是響應式的,手機和PC都有不錯的閱讀體驗
  • 多語言,天生支持多語言,只需增長修改配置即可。讓世界瞭解你的網站
  • 代碼美,請記住:不單單是代碼高亮,使用md2site輕鬆可讓代碼內的某些代碼高亮
  • 超方便,npm run dev預覽,npm run dist一鍵生成網站。不知足現有佈局或樣式可輕鬆進行二次開發

快速開始

$ npm install md2site -g

安裝完以後就可使用md2site 命令了。git

$ md2site init your_project_name

好比我建立一個omi的文檔:github

這個時間比較長,由於還會安裝相關的npm依賴包。安裝成功能夠看到:web

$ cd your_project_name

轉到對應的項目目錄。npm

找到your_project_name目錄下的docs目錄:markdown

在裏面寫你的markdown文檔。在config.js中配置對應的目錄樹:工具

let config = {
    menus: {
        cn: [
            {
                active: true,
                title: '快速開始',
                currentIndex: 0,
                list: [
                    {name: '安裝', md: 'installation'},
                    {name: '組件', md: 'components'},
                    {name: '組件通信', md: 'communication'}
                ]
            }
        ],
        en: [
            {
                active: true,
                title: 'QUICK START',
                currentIndex: 0,
                list: [
                    {name: 'Installation', md: 'installation'},
                    {name: 'Components', md: 'components'},
                    {name: 'Communication', md: 'communication'}
                ]
            }
        ]
    }
}

export default config;

寫的過程當中能夠經過下面的命令能夠進行網站預覽佈局

$ npm run dev

也可發佈部署:網站

$ npm run dist

一款漂亮的多語言響應式無刷新的精明文檔網站就這麼搞定了!簡單吧~~code

Markdown語法擴展

若是你想讓代碼塊中的某些行高亮,好比這個樣子:

你可使用這種語法來標記須要高亮的行:

上面表明:1到3行以及26行高亮。

Github

相關文章
相關標籤/搜索