●
本文僅是縮略,筆者已將詳細內容發布到github上
● 目錄
● 本文概述
● mkdocs-material介紹
● 安裝
● 初始化專案
● 修改主題
● 執行
● 發布到github pages
● 發布到個人http server
● mkdocs.yml注意事項
● 新增頁面
● 新增擴充套件
● markdown語法
● 其他功能
● 最佳實踐
本文概述
mkdocs-material入門,包括安裝、執行、發布至github-pages及個人站點
mkdocs-material介紹
符合google material ui規範的靜態文件**生成器,使用markdown進行文件書寫
mkdocs
● python編寫的markdown直譯器、編譯器,帶有本地cli工具
● 自帶基於tornado的小型http服務,用於本地除錯
● 內建一鍵式發布至github pages
● 內建mkdocs風格、readthedocs風格的主題,並支援自定義主題
● 支援呼叫python模組實現語法及渲染的擴充套件
mkdocs-material
● python模組,符合google material ui規範的mkdocs自定義主題
● 針對特定語法、功能做了渲染優化
● 根據客戶端瀏覽器頁面尺寸自動縮放,對pc、移動裝置都友好
● 豐富的頁面配色,多達19種主體配色和16種懸停鏈結文字配色
● 支援中文搜尋
●
如何在mac上搭建GitHub
準備工作 a 安裝git b 註冊github賬號1,檢查是否已經存在ssh目錄 開啟終端,輸入 cd ssh 如果是第一次操作,會顯示 no such file or directory2,生成金鑰 輸入 ssh keygen 接著連續3次回車即可3,檢查生成的金鑰檔案 輸入 ls 顯示 id r...
如何在github上提交pr
git remote add upstreamgit remote vgit checkout b fix npegit add git commit m fix npe git push origin fix npe 將當前分支推送到自己的遠端倉庫 注意事項 每次pr之前,首先與遠端倉庫做 同步 ...
如何在github上新增金鑰
首先得在本地安裝好git,有github賬號 1.本地安裝好git 2.桌面右鍵 git bash here 開啟git命令列 3.ssh keygen t rsa c nideyouxiang com 全部按enter,後面為github所填郵箱 4.cd ssh 如果沒有執行第三步,則不會有這個...