Skip to content

xinmu99/docDirTreeToMd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

docDirTreeToMd

create docment dir to docrify sidebar.md

文件目录树生成 markdown 目录导航

生成文档书目,比如docsify sidebar,自动文件夹md导航

<link rel="stylesheet" href="https://xinmu99.github.io/docDirTreeToMd/filesidebar.css">
<script src="https://xinmu99.github.io/docDirTreeToMd/filesidebar.js"></script>
<script>
    make_filenav ({
        filetypes : ['md'], // 筛选文件 默认
        file_tree_url : null,
        gtihub_repo: "owner/repo",
        sidebar_css: 'div.sidebar-nav',
    });
</script>

参数说明

filetypes : ['md'], // 筛选文件类型, 默认md,可略

file_tree_url : null, // 获取文档树json url , 默认 github api ,可略

  • 返回json数据格式 :

    {
      "tree": [
                {"path": "README.md",
                },
                { "path": "books.md",
                },
                { "path": "democratize_peacefully/README.md",
                }
        	]
     }
    

gtihub_repo: file_tree_url 为空,默认使用gihub,则必须提供 "owner/repo"

sidebar_css: 'div.sidebar-nav', 插入导航的位置原素css

自己生成文件目录 可以用以下py脚本

应用于 docrify sidebar.md

  • 文件类型过滤 说明

    def filter_f_d(x): return x.split('.')[-1] not in {"py"} 过滤函数,默认设置为 排除 py类型文件

    如果 仅仅给md文件做目录需要修改为:

    def filter_f_d(x): return x.split('.')[-1] in {"md"}


比如生成以下目录树

  • 1.1. 7plus.xml
  • 1.2. Accessor.xml
  • [1.3. All Events.xml](/All Events.xml)
  • 1.4. CMD.xml
  • [1.5. Context Menu.xml](/Context Menu.xml)
  • [1.6. Explorer Buttons.xml](/Explorer Buttons.xml)
  • 1.7. Explorer.xml
  • [1.8. Fast Folders.xml](/Fast Folders.xml)
  • [1.9. File Dialog.xml](/File Dialog.xml)
  • 1.10. Internet.xml
  • [1.11. Misc Hotkeys.xml](/Misc Hotkeys.xml)
  • [1.12. Numpad Enhancements.xml](/Numpad Enhancements.xml)
  • [1.13. Old Versions](/Old Versions)
    • [1.13.1. 2.3.0](/Old Versions\2.3.0)
      • [1.13.1.1. All Events.xml](/Old Versions\2.3.0\All Events.xml)
    • [1.13.2. 2.4.0](/Old Versions\2.4.0)
      • [1.13.2.1. All Events.xml](/Old Versions\2.4.0\All Events.xml)
    • [1.13.3. 2.5.0](/Old Versions\2.5.0)
      • [1.13.3.1. All Events.xml](/Old Versions\2.5.0\All Events.xml)
  • 1.14. Taskbar.xml
  • [1.15. Window Handling.xml](/Window Handling.xml)

About

create docment dir to docrify sidebar.md

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published