官網(wǎng)地址:https://docsify.js.org/
在Docsify官網(wǎng)對Docsify是這樣的描述的:
使用官網(wǎng)推薦使用npm的方式去安裝使用,但是如果不是公司級別的需求(文檔需要統(tǒng)一管理),個(gè)人覺得沒有必要去搭建一個(gè)項(xiàng)目去做這件事,就好像我寫了一個(gè)
接口,我更加希望在該項(xiàng)目中直接寫好文檔,然后可以直接看。所以這里我不介紹官網(wǎng)使用,而是介紹在SpringBoot項(xiàng)目如何使用Docsify生成文檔。
下面附上效果圖:
org.springframework.boot spring-boot-starter-thymeleaf 第二步:在resource下新建html。目錄結(jié)構(gòu)如下,這里大家可以將view下的目錄移到static中,根據(jù)個(gè)人的愛好
resouce│ │ └───static││└───view│ │ │ │ │ ││ └───doc│ │ _sidebar.md(側(cè)邊欄目錄)│ │ README.md (文檔內(nèi)容)│ │ ...│ └───templates │ doc.html │ ...編寫templates目錄下的doc.html,這里和官方文檔介紹相似
@Controllerpublic class View { @RequestMApping("/view/doc") public String viewDoc(HashMap map) { return "doc"; }}如果設(shè)置了攔截器,注意放開這些靜態(tài)資源,否則會(huì)出現(xiàn)404,如果沒有設(shè)置攔截器,應(yīng)該會(huì)正常訪問
@Configurationpublic 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
1.《docsify SpringBoot整合Docsify生成網(wǎng)站文檔》援引自互聯(lián)網(wǎng),旨在傳遞更多網(wǎng)絡(luò)信息知識(shí),僅代表作者本人觀點(diǎn),與本網(wǎng)站無關(guān),侵刪請聯(lián)系頁腳下方聯(lián)系方式。
2.《docsify SpringBoot整合Docsify生成網(wǎng)站文檔》僅供讀者參考,本網(wǎng)站未對該內(nèi)容進(jìn)行證實(shí),對其原創(chuàng)性、真實(shí)性、完整性、及時(shí)性不作任何保證。
3.文章轉(zhuǎn)載時(shí)請保留本站內(nèi)容來源地址,http://f99ss.com/keji/346896.html