亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專欄INFORMATION COLUMN

Asciidoctor Maven插件使用

Leo_chen / 2572人閱讀

摘要：在項(xiàng)目中可以使用的插件方式將文件格式轉(zhuǎn)化為等文件格式?？焖偃腴T工程結(jié)構(gòu)文件默認(rèn)命令，配置后可以直接使用編譯執(zhí)行命令生成的可以使用或者等服務(wù)進(jìn)行部署，甚至可以使用進(jìn)行自動(dòng)化部署。參考資料插件中文文檔中文亂碼問題解決方案

在項(xiàng)目應(yīng)用中，我們會(huì)寫很多文檔去傳遞我們的設(shè)計(jì)思想、開發(fā)經(jīng)驗(yàn)、采坑經(jīng)歷等等。使用Asciidoc的格式對(duì)非技術(shù)人員就不是那么的友好，或者說傳遞性、通用性與PDF和網(wǎng)頁相比就差很多了。在JVM項(xiàng)目中可以使用Maven的插件方式將.adoc文件格式轉(zhuǎn)化為PDF、HTML、EPUB等文件格式。

快速入門

工程結(jié)構(gòu)

|doc-demo
|-src
|--main
|---asciidoc
|----.adoc文件
|---resources
|----images
|pom.xml

pom.xml



    4.0.0

    com.demo
    docs
    1.1.0-SNAPSHOT

    
        UTF-8
        UTF-8
        UTF-8
        1.8
        1.8
        1.5.6
        1.5.4.1
        1.7.26
    
    
        
        process-resources
        
            
                src/main/resources
                ${project.build.directory}/book
            
        
        
            
                org.asciidoctor
                asciidoctor-maven-plugin
                1.5.5
                
                    
                        output-html
                        generate-resources
                        
                            process-asciidoc
                        
                        
                            html5
                            prettify
                            
                                left
                                font
                                true
                                
                                
                            
                        
                    
                
                
                    
                    
                        org.jruby
                        jruby-complete
                        ${jruby.version}
                    
                    
                    
                        org.asciidoctor
                        asciidoctorj
                        ${asciidoctorj.version}
                    
                    
                        org.asciidoctor
                        asciidoctorj-diagram
                        ${asciidoctorj.diagram.version}
                    
                
                
                    ${project.build.directory}/book
                    book.adoc
                    ./
                    false
                    
                        asciidoctor-diagram

執(zhí)行mvn命令

mvn clean process-asciidoc

生成的HTML可以使用Http Server或者Nginx等服務(wù)進(jìn)行部署，甚至可以使用Jenkins進(jìn)行自動(dòng)化部署。

生成PDF

工程結(jié)構(gòu)

|doc-demo
|-src
|--main
|---asciidoc
|----data
|-----fonts
|-----themes
|----.adoc文件
|---resources
|----images
|pom.xml

pom.xml



    4.0.0

    com.tairanchina.csp.dmp
    docs
    1.1.0-SNAPSHOT

    
        UTF-8
        UTF-8
        UTF-8
        1.8
        1.8
        1.5.6
        1.5.4.1
        1.7.26
        1.5.0-alpha-zh.16
    
    
        
        
        
        process-resources
        
            
                src/main/resources
                ${project.build.directory}/book
            
        
        
            
                org.asciidoctor
                asciidoctor-maven-plugin
                1.5.5
                
                    
                        output-html
                        generate-resources
                        
                            process-asciidoc
                        
                        
                            html5
                            prettify
                            
                                left
                                font
                                true
                                
                                
                            
                        
                    

                    
                        output-pdf
                        generate-resources
                        
                            process-asciidoc
                        
                        
                            pdf
                            coderay
                            book
                            
                                font
                                
                                
                                
                                -
                                data/fonts
                                data/themes
                                cn
                            
                        
                    
                
                
                    
                    
                        org.jruby
                        jruby-complete
                        ${jruby.version}
                    
                    
                    
                        org.asciidoctor
                        asciidoctorj
                        ${asciidoctorj.version}
                    
                    
                        org.asciidoctor
                        asciidoctorj-diagram
                        ${asciidoctorj.diagram.version}
                    
                    
                        org.asciidoctor
                        asciidoctorj-pdf
                        ${asciidoctorj.pdf.version}
                    
                
                
                    ${project.build.directory}/book
                    book.adoc
                    ./
                    false
                    
                        asciidoctor-diagram

執(zhí)行mvn命令

mvn clean process-asciidoc
由于PDF格式插件沒有安裝中文字體，生成的PDF格式上會(huì)存在缺失，上方的fonts和themes可以對(duì)PDF的生成格式進(jìn)行自定義，有時(shí)候?yàn)榱朔奖?，可以將其與asciidoctorj-pdf源碼進(jìn)行合并，手動(dòng)打一個(gè)依賴包，放到自己的私服倉庫中。
常見問題

在生成PDF的時(shí)候，可能code部分會(huì)存在很多空格的問題，一般產(chǎn)生這樣的問題不是字體問題，而是編寫格式有問題，可以選擇將``符號(hào)去掉。

參考資料

Example

Asciidoctor插件中文文檔

Asciidoctor-PDF

中文亂碼問題解決方案

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/71499.html

相關(guān)文章

  • Gradle環(huán)境下導(dǎo)出Swagger為PDF

    摘要：沒錯(cuò)，不支持，從導(dǎo)出的文檔也可以看到，部分中文無法顯示，目前我也尚未找到是否有配置可以實(shí)現(xiàn)這個(gè)功能。相對(duì)前面的方式，使用起來更加簡(jiǎn)單，也可以修改配置輸出中文。 更多精彩博文，歡迎訪問我的個(gè)人博客 說明 我個(gè)人是一直使用Swagger作為接口文檔的說明的。但是由于在一些情況下，接口文檔說明需要以文件的形式交付出去，如果再重新寫一份文檔難免有些麻煩。于是在網(wǎng)上看到了Swagger2Mar...

    OnlyMyRailgun 評(píng)論0 收藏0

  • Spring Boot [如何優(yōu)雅的編寫文檔]

    摘要：導(dǎo)讀在團(tuán)隊(duì)協(xié)作的時(shí)候許多時(shí)候需要用到接口文檔，我們通常通過手工編寫大量重復(fù)格式的文檔，讓我想起了程序員最討厭的兩件事沒有文檔，編寫文檔。對(duì)應(yīng)的資料可自行谷歌。關(guān)于和官網(wǎng)是這樣描述的。我們可以理解為為基于構(gòu)建的自動(dòng)生成文檔。 導(dǎo)讀： 在團(tuán)隊(duì)協(xié)作的時(shí)候許多時(shí)候需要用到接口文檔，我們通常通過手工編寫大量重復(fù)格式的文檔，讓我想起了程序員最討厭的兩件事：沒有文檔，編寫文檔。哈哈，如果使用過swa...

    曹金海 評(píng)論0 收藏0

  • SpringBoot非官方教程 | 第十篇： 用Spring Restdocs創(chuàng)建API文檔

    摘要：建一個(gè)單元測(cè)試類其中，注解開啟了生成文件，并指定了存放位置。怎么用創(chuàng)建一個(gè)新文件用構(gòu)建文檔這個(gè)例子非常簡(jiǎn)單，通過單元測(cè)試和一些簡(jiǎn)單的配置就能夠得到文檔了。 準(zhǔn)備工作 你需要15min Jdk 1.8 maven 3.0+ idea 創(chuàng)建工程 引入依賴，其pom文件： org.springframework.boot spring-boot-...

    RdouTyping 評(píng)論0 收藏0

  • 使用spring boot + swagger自動(dòng)生成HTML、PDF接口文檔，并解決中文顯示為空白

    摘要：首先是從下載了，這個(gè)已經(jīng)能夠生成和文檔了，但是對(duì)中文支持不好，中文大部分會(huì)顯示為空白。關(guān)于這個(gè)對(duì)中文支持不好，查了很多資料，應(yīng)該是字體和主題的原因，所以參考了很多資料，結(jié)合當(dāng)前這個(gè)，做出了最終的能很好支持中文的，最終地址。 做后端開發(fā)，自然離不開接口文檔，接口文檔不僅方便后端開發(fā)人員之間查看，更是前端人員必要的文檔，也有可能提供給第三方來調(diào)用我們的接口。但是，寫接口文檔太費(fèi)時(shí)間，而且如...

    fjcgreat 評(píng)論0 收藏0

  • 使用Maven管理Java項(xiàng)目

    摘要：添加的的依賴，可以從項(xiàng)目的中拷貝使用命令編譯項(xiàng)目。在子模塊中我們可以這樣使用引入父模塊坐標(biāo)三使用建立項(xiàng)目新建一個(gè)項(xiàng)目，選擇，如圖所示在中配置插件可參見官方文檔。部署項(xiàng)目到即可。 一、Maven入門 1.下載maven Maven是基于項(xiàng)目對(duì)象模型（Project Object Model），可以通過一小段描述信息來管理項(xiàng)目的構(gòu)建、報(bào)告和文檔的項(xiàng)目管理工具,提供了一個(gè)倉庫的概念，統(tǒng)一...

    yiliang 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

最新活動(dòng)
閱讀需要支付1元查看
<