Skip to content

Commit

Permalink
Add mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
mre committed Sep 27, 2018
1 parent 53ac65b commit 9fc83d2
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
site
docs/*
!docs/css
19 changes: 19 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.PHONY: install
install:
pip install mkdocs==1.0.4
pip install mkdocs-material==3.0.4
pip install Markdown==3.0.1

.PHONY: link
link:
ln -sf $(CURDIR)/README.md $(CURDIR)/docs/index.md
ln -sf $(CURDIR)/awesome.png $(CURDIR)/docs/awesome.png

.PHONY: serve
serve: link
mkdocs serve

.PHONY: deploy
deploy: link
mkdocs gh-deploy

37 changes: 37 additions & 0 deletions docs/css/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;
}
}
27 changes: 27 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
site_name: 'Awesome Static Analysis'
site_url: 'https://awesome-static-analysis.com'
site_description: 'A curated list of linters, code quality checkers, and other static analysis tools for various programming languages'
site_author: 'Matthias Endler'
repo_name: 'mre/awesome-static-analysis/'
repo_url: 'https://github.com/mre/awesome-static-analysis/'
theme: 'material'
extra:
feature:
tabs: false
palette:
primary: 'red'
accent: 'pink'
social:
- type: 'github'
link: 'https://github.com/mre'
- type: 'twitter'
link: 'https://twitter.com/matthiasendler'
- type: 'linkedin'
link: 'https://www.linkedin.com/in/matthiasendler'
google_analytics:
- 'UA-693428-1'
- 'auto'
extra_css:
- css/extra.css
markdown_extensions:
- toc:

0 comments on commit 9fc83d2

Please sign in to comment.