sb2nov / mac-setup

Installing Development environment on macOS
https://sourabhbajaj.com/mac-setup/
Other
7.18k stars 1.02k forks source link

Add Treeview Plugin for Reading Enhancement #255

Closed aleen42 closed 5 years ago

aleen42 commented 5 years ago

Free free to add the plugin, gitbook-treeview, for generating treeview automatically during building each pages. It is helpful for reading enhancement.

sb2nov commented 5 years ago

Can you render the guide and add a screenshot about where this would be useful ?

Most of the pages in mac-setup are fairly small so I would love to learn more about where this can help the readers.

aleen42 commented 5 years ago

image

If there is a large document with sufficient complicated structure, it is helpful to show this and help reader to link to the corresponding header by scrolling.

{
    "plugins": [
        "page-treeview"
    ],
    "pluginsConfig": {
        "page-treeview": {
            "copyright": "Copyright © aleen42",
            "minHeaderCount": "2",
            "minHeaderDeep": "2"
        }
    }
}

If there is fairly small document, you can set up minHeaderCount or minHeaderDeep for specifying some documents not to generate such a tree view, when it is constructed with less than two headers or with less than two embbeded headers,

sb2nov commented 5 years ago

Thanks for explaining. I scanned the pages in the guide and nothing has more than 2 levels of depth so I think we should close the PR for now and re-visit this if that changes.

Thanks again for the help.