關於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
<center>每天學Java/<center>
## 文章介紹
* [文章介紹](/)
## Java運用
* [ThreadLocal三種使用場景](case/ThreadLocal)
* [Stream在集合中的8種應用案例](case/Stream)
* [阻塞隊列的使用](case/queue)
* [SpringBoot整合docsify](case/Docsify)
README.md
## 說明
每天學Java(小程序和公眾號)做到今日,仍然是籍籍無名,一開始想的很多,到如今只當作自己的興趣
來弄,但是想到做到這一步,停下來也沒有意義,不如繼續折騰折騰,提升提升自己能力水平。於是
每天學Java的網站也就出來了,網站將小程序的題庫數據抽離出來,在加上新的模塊:功能集錦,用
於將自己工作中使用的技術進行一次整理封裝和優化。
到這裡就完成SpringBoot結合Docsify生成文檔,筆者覺得在一些小項目中,這樣可以非常快速的
生成網站文檔,不用另外新建項目。
閱讀更多 程序猿開發日記 的文章