[README] Add table of contents (Closes #4458)
This commit is contained in:
		
							parent
							
								
									ac78b5e97b
								
							
						
					
					
						commit
						b50e3bc67f
					
				
					 2 changed files with 25 additions and 4 deletions
				
			
		| 
						 | 
				
			
			@ -11,8 +11,19 @@ README_FILE = os.path.join(ROOT_DIR, 'README.md')
 | 
			
		|||
with io.open(README_FILE, encoding='utf-8') as f:
 | 
			
		||||
    readme = f.read()
 | 
			
		||||
 | 
			
		||||
PREFIX = '%YOUTUBE-DL(1)\n\n# NAME\n'
 | 
			
		||||
readme = re.sub(r'(?s)# INSTALLATION.*?(?=# DESCRIPTION)', '', readme)
 | 
			
		||||
PREFIX = '''%YOUTUBE-DL(1)
 | 
			
		||||
 | 
			
		||||
# NAME
 | 
			
		||||
 | 
			
		||||
youtube\-dl \- download videos from youtube.com or other video platforms
 | 
			
		||||
 | 
			
		||||
# SYNOPSIS
 | 
			
		||||
 | 
			
		||||
**youtube-dl** \[OPTIONS\] URL [URL...]
 | 
			
		||||
 | 
			
		||||
'''
 | 
			
		||||
readme = re.sub(r'(?s)^.*?(?=# DESCRIPTION)', '', readme)
 | 
			
		||||
readme = re.sub(r'\s+youtube-dl \[OPTIONS\] URL \[URL\.\.\.\]', '', readme)
 | 
			
		||||
readme = PREFIX + readme
 | 
			
		||||
 | 
			
		||||
if sys.version_info < (3, 0):
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue