MDwiki安装与配置

MDwiki的安装配置详情可见官网

一、安装

1、新建项目文件夹blog

2、下载MDwiki,下载地址

3、拷贝下载包中的mdwiki.html到项目文件夹中

4、在文件夹中新建index.md文件,此为项目的主文件(可以在文件中写入主页相关内容)

5、在浏览器中打开mdwiki.html即可预览

二、配置导航

1、在项目目录下新建navigation.md文件

2、可以在文件中写入导航配置信息,导航基本代码如下:

# Brand name

[Menu Item 1]()

  * # SubMenu Heading 1
  * [SubMenu Item 1](subitem1.md)
  * [SubMenu Item 2](subitem2.md)
  - - - -
  * # SubMenu Heading 2
  * [SubMenu Item 3](subitem3.md)
  - - - -
  * # SubMenu Heading 3
  * [SubMenu Item 3](subitem3.md)

[Menu Item 2](item2.md)
- - - -
[Menu Item 3](item3.md)

3、MDwiki自带更换主题功能,可在navigation.md中配置,添加以下代码即可

[gimmick:themechooser](主题)

三、项目配置

1、在项目目录中新建config.json文件,在其中可进行一些项目的基本配置,配置文件代码如下:

{
    "useSideMenu": true,
    "lineBreaks": "gfm",
    "additionalFooterText": "All content and images © by John Doe",
    "anchorCharacter": "#"
}

2、字段基本说明

• useSideMenu: 是否使用侧边目录,默认值:true

• additionalFooterText: 底部显示的文字,默认值:"",设置该值后会添加到底部的"Website generated with MDwiki © Timo Dörr and contributors."之前

• anchorCharacter: 设置character/text的值

• title: 网页的标题,默认值:“MDWiki”

• lineBreaks: 断行方式,默认值:“gfm”