Necessary Pigeonholing Mechanism

    gitbook-plugin-auto-summary

    0.0.2 • Public • Published

    gitbook-plugin-auto-summary

    Plugin for gitbook to automate generate SUMMARY.md

    Rules

    • Sorted by filename
    • Ignore files which are with prefix _
    • Pick first heading text as title
    • Parts can be defined in book.json

    How to use

    {
        "plugins": ["auto-summary"],
        "pluginsConfig": {
          "auto-summary": {
            "parts": { 
               "README.md": "Part I",
               "parts_2/**/*.md": "Part II"
            }      
          }
        }
    }

    will be

     
    * [others](others/README.md)
     
    ## Part I
     
    * [xxx](README.md)
     
    ## Part II
     
    * [parts_2](parts_2/README.md)
     

    Keywords

    none

    Install

    npm i gitbook-plugin-auto-summary

    DownloadsWeekly Downloads

    23

    Version

    0.0.2

    License

    none

    Unpacked Size

    18.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • morlay_null