mirror of
				https://github.com/vinta/awesome-python.git
				synced 2025-10-30 23:48:03 -04:00 
			
		
		
		
	use MkDocs to generate a static website
This commit is contained in:
		
							parent
							
								
									2917299708
								
							
						
					
					
						commit
						65ef34f2d2
					
				
					 5 changed files with 60 additions and 0 deletions
				
			
		
							
								
								
									
										4
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							| 
						 | 
				
			
			@ -1,2 +1,6 @@
 | 
			
		|||
.DS_Store
 | 
			
		||||
 | 
			
		||||
*.py[co]
 | 
			
		||||
 | 
			
		||||
docs/index.md
 | 
			
		||||
site/
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										12
									
								
								Makefile
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								Makefile
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,12 @@
 | 
			
		|||
BASEDIR=$(CURDIR)
 | 
			
		||||
DOCDIR=$(BASEDIR)/docs
 | 
			
		||||
 | 
			
		||||
install:
 | 
			
		||||
	pip install mkdocs
 | 
			
		||||
 | 
			
		||||
preview:
 | 
			
		||||
	mkdocs serve
 | 
			
		||||
 | 
			
		||||
deploy:
 | 
			
		||||
	ln -sf $(BASEDIR)/README.md $(DOCDIR)/index.md
 | 
			
		||||
	mkdocs gh-deploy --clean
 | 
			
		||||
							
								
								
									
										1
									
								
								docs/CNAME
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								docs/CNAME
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1 @@
 | 
			
		|||
awesome-python.com
 | 
			
		||||
							
								
								
									
										37
									
								
								docs/extra.css
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										37
									
								
								docs/extra.css
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,37 @@
 | 
			
		|||
.bs-sidebar.well {
 | 
			
		||||
    /* margin-bottom: 0; */
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
.bs-sidebar .nav > li > a:hover,
 | 
			
		||||
.bs-sidebar .nav > li > a:focus {
 | 
			
		||||
    border: none;
 | 
			
		||||
    border-left: 2px solid;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
.bs-sidebar .nav > .active > a,
 | 
			
		||||
.bs-sidebar .nav > .active:hover > a,
 | 
			
		||||
.bs-sidebar .nav > .active:focus > a {
 | 
			
		||||
    border: none;
 | 
			
		||||
    border-left: 2px solid;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@media (min-width: 992px) {
 | 
			
		||||
    .bs-sidebar.affix {
 | 
			
		||||
        /* top: 60px; */
 | 
			
		||||
        /* bottom: 0px; */
 | 
			
		||||
        top: 80px;
 | 
			
		||||
        bottom: 23px;
 | 
			
		||||
        overflow: auto;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@media (min-width: 1200px) {
 | 
			
		||||
    .bs-sidebar.affix-bottom,
 | 
			
		||||
    .bs-sidebar.affix {
 | 
			
		||||
        width: 280px;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    .container > .col-md-9 {
 | 
			
		||||
        padding-left: 40px;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										6
									
								
								mkdocs.yml
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								mkdocs.yml
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,6 @@
 | 
			
		|||
site_name: Awesome Python
 | 
			
		||||
site_url: http://awesome-python.com
 | 
			
		||||
site_description: "A curated list of awesome Python frameworks, libraries and software"
 | 
			
		||||
site_author: Vinta Chen
 | 
			
		||||
repo_url: https://github.com/vinta/awesome-python
 | 
			
		||||
theme: flatly
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue