Skip to content

Commit

Permalink
Add GItHub link and update mkdocs-material config
Browse files Browse the repository at this point in the history
  • Loading branch information
campb303 committed Dec 23, 2020
1 parent a9a4554 commit 5ca3f42
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
1 change: 1 addition & 0 deletions api/documentation/docs/images/favicon.ico
40 changes: 39 additions & 1 deletion api/documentation/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,48 @@
site_name: WebQueue2
################################################################################
# mkdocs Settings
# See: https://www.mkdocs.org/user-guide/configuration/
################################################################################

site_name: webqueue2 API
repo_url: https://github.itap.purdue.edu/ECN/webqueue2
plugins:
- search
markdown_extensions:
- toc:
permalink: ⚓︎
- admonition
- codehilite
- mkautodoc



################################################################################
# Material for mkdocs Settings
# See: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
################################################################################

# TODO: Implement offline search
# See: https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#offline-search
# TODO: Implement versioning
# See: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning

theme:
name: material
palette:
primary: deep purple
accent: teal
icon:
logo: material/book-open
# The favicon is symlinked from the ReactJS public folder
favicon: images/favicon.ico
features:
- navigation.sections

extra:
social:
- icon: fontawesome/brands/slack
link: https://purdueecn.slack.com/archives/C019K7PSPNW
name: webqueue2 on Slack
- icon: fontawesome/brands/github
link: https://github.itap.purdue.edu/ECN/webqueue2
name: webqueue2 on GitHub

0 comments on commit 5ca3f42

Please sign in to comment.