Skip to content

Commit 65ef34f

Browse files
committed
use MkDocs to generate a static website
1 parent 2917299 commit 65ef34f

File tree

5 files changed

+60
-0
lines changed

5 files changed

+60
-0
lines changed

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
.DS_Store
2+
23
*.py[co]
4+
5+
docs/index.md
6+
site/

Makefile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
BASEDIR=$(CURDIR)
2+
DOCDIR=$(BASEDIR)/docs
3+
4+
install:
5+
pip install mkdocs
6+
7+
preview:
8+
mkdocs serve
9+
10+
deploy:
11+
ln -sf $(BASEDIR)/README.md $(DOCDIR)/index.md
12+
mkdocs gh-deploy --clean

docs/CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
awesome-python.com

docs/extra.css

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.bs-sidebar.well {
2+
/* margin-bottom: 0; */
3+
}
4+
5+
.bs-sidebar .nav > li > a:hover,
6+
.bs-sidebar .nav > li > a:focus {
7+
border: none;
8+
border-left: 2px solid;
9+
}
10+
11+
.bs-sidebar .nav > .active > a,
12+
.bs-sidebar .nav > .active:hover > a,
13+
.bs-sidebar .nav > .active:focus > a {
14+
border: none;
15+
border-left: 2px solid;
16+
}
17+
18+
@media (min-width: 992px) {
19+
.bs-sidebar.affix {
20+
/* top: 60px; */
21+
/* bottom: 0px; */
22+
top: 80px;
23+
bottom: 23px;
24+
overflow: auto;
25+
}
26+
}
27+
28+
@media (min-width: 1200px) {
29+
.bs-sidebar.affix-bottom,
30+
.bs-sidebar.affix {
31+
width: 280px;
32+
}
33+
34+
.container > .col-md-9 {
35+
padding-left: 40px;
36+
}
37+
}

mkdocs.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
site_name: Awesome Python
2+
site_url: http://awesome-python.com
3+
site_description: "A curated list of awesome Python frameworks, libraries and software"
4+
site_author: Vinta Chen
5+
repo_url: https://github.com/vinta/awesome-python
6+
theme: flatly

0 commit comments

Comments
 (0)