Skip to content

Commit

Permalink
use MkDocs to generate a static website
Browse files Browse the repository at this point in the history
  • Loading branch information
vinta committed Jun 6, 2015
1 parent 2917299 commit 65ef34f
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
.DS_Store

*.py[co]

docs/index.md
site/
12 changes: 12 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
awesome-python.com
37 changes: 37 additions & 0 deletions docs/extra.css
Original file line number Diff line number Diff line change
@@ -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 changes: 6 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 65ef34f

Please sign in to comment.