關于Docsify

官網地址:https://docsify.js.org/

在Docsify官網對Docsify是這樣的描述的:

docsify 是一個動態生成文檔網站的工具。不同于 GitBook、Hexo 的地方是它不會生成將 .md 轉成 .html 文件，所有轉換工作都是在運行時進行

使用

官網推薦使用npm的方式去安裝使用，但是如果不是公司級別的需求(文檔需要統一管理)，個人覺得沒有必要去搭建一個項目去做這件事，就好像我寫了一個

接口，我更加希望在該項目中直接寫好文檔，然后可以直接看。所以這里我不介紹官網使用，而是介紹在SpringBoot項目如何使用Docsify生成文檔。

下面附上效果圖:

過程

• 第一步:新建SpringBoot項目，記得勾選thymeleaf，如果有現成的。Spring Boot項目，引入下面依賴

 
 org.springframework.boot
 spring-boot-starter-thymeleaf
 

• 第二步:在resource下新建html。目錄結構如下，這里大家可以將view下的目錄移到static中，根據個人的愛好

resouce
│ 
│ 
└───static
│
│
└───view
│ │ 
│ │ 
│ │
│ └───doc
│ │ _sidebar.md（側邊欄目錄）
│ │ README.md （文檔內容）
│ │ ...
│ 
└───templates
 │ doc.html
 │ ...

• 編寫templates目錄下的doc.html，這里和官方文檔介紹相似

• 配置Controller，以便通過URL訪問到doc.html

@Controller
public class View {
 @RequestMApping("/view/doc")
 public String viewDoc(HashMap map) {
 return "doc";
 }
}

• 如果設置了攔截器，注意放開這些靜態資源，否則會出現404，如果沒有設置攔截器，應該會正常訪問

@Configuration
public class MyInterceptorConfig extends WebMvcConfigurationSupport {
 @Autowired
 private MyInterceptor loginInterceptor;

 @Override
 protected void addInterceptors(InterceptorRegistry registry) {
 registry.addInterceptor(loginInterceptor).addPathPatterns("/**");
 super.addInterceptors(registry);
 }

 @Override
 protected void addResourceHandlers(ResourceHandlerRegistry registry) {
 registry.addResourceHandler("/view/**")
 .addResourceLocations("classpath:/view/");
 }
}

• MD文件

_sidebar.md