import os import glob import sys from urllib.parse import quote import platform path_split = '/' if platform.system() == 'Windows': path_split = '\\' IGNORE = [ 'src', '.git', 'vendor', 'docs', 'assets', "README.md", ] HEADER = [ "* [Overview]()" ] FOOTER = [ "", "

", "", "* [Back](../)" ] def make_display_name(name): name = name.split(".md")[0] # Remove .md extension name = name.replace('-', ' ') # Add space instead of - name = name.replace('_', ' ') # Add space instead of _ # Capitalize all words # (Exclude some words from capitalization) forbidden = ['a', 'on', 'to', 'and', 'with', 'how', 'at', 'the'] capitalized = '' for word in name.split(' '): if (word.lower() not in forbidden): capitalized += word[0].upper() + word[1:] # capitalized += word.capitalize() else: capitalized += word.lower() capitalized += ' ' name = capitalized.strip() return name def generate_sidebar(path, entries): print(path) sidebar_file = open(os.path.join(path,'_sidebar.md'), 'w', encoding="utf-8") for entry in entries: sidebar_file.write(entry+'\n') sidebar_file.close() def acceptfile(name): if os.path.splitext(name)[1] != ".md": return False if name in IGNORE: return False if name.startswith('.') or name.startswith('_'): return False return True def acceptdir(root,d): if d in IGNORE: return False # if not acceptroot(root): return False if os.path.exists(os.path.join(root,d,'README.md')): return True return False def acceptroot(root): parts = root.split(path_split) if len(parts) > 1: for part in parts: if part in IGNORE: return False return True def scan_dir(path="."): for root, dirs, files in os.walk(path): dirs = sorted(dirs) files = sorted(files) entries = [] if len(root.split(path_split)) == 1: entries += HEADER elif not acceptroot(root): continue else: entries.append("* [{}]()".format(make_display_name(root.split(path_split)[-1])) ) stop = [] for d in dirs: if not acceptdir(root,d): stop.append(d) continue entries.append("* [{}](./{}/)".format(make_display_name(d), quote(d))) for d in stop: dirs.remove(d) for f in files: if not acceptfile(f): continue entries.append("* [{}]({})".format(make_display_name(f), quote(f))) if len(root.split(path_split)) > 1: entries += FOOTER generate_sidebar(root, entries) if __name__ == "__main__": scan_dir() print('✅ All done!')