Skip to content

Commit

Permalink
mkdocs tuning
Browse files Browse the repository at this point in the history
  • Loading branch information
mbaudis committed Mar 13, 2024
1 parent 1e2e831 commit cf9b061
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
23 changes: 23 additions & 0 deletions .github/workflows/mkdocs-build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: mk-docs
on:
push:
branches:
- main
- master
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: pip install mkdocs-macros-plugin
- run: pip install pymdown-extensions
- run: pip install mkdocs-mermaid2-plugin
- run: pip install mdx_gh_links
- run: pip install mkdocs-with-pdf
- run: mkdocs gh-deploy --force
30 changes: 29 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
site_name: My Docs
site_name: 'GA4GH Beacon Genomic Variation Query Standards'
site_description: 'Development Site of the GA4GH Beacon community'
site_author: Michael Baudis
copyright: '© Copyright 2024 GA4GH and Beacon Contributors'
repo-name: variant-query-types
repo_url: https://github.com/ga4gh-beacon/variant-query-types
edit_uri: edit/main/docs/

###############################################################################

theme:
name: material
palette:
primary: light blue
features:
- content.tabs.link
- search.highlight
- search.share
- navigation.instant
- navigation.tracking
- navigation.sections
- toc.integrate

plugins:
- search
- macros

extra:
excerpt_separator: <!--more-->

0 comments on commit cf9b061

Please sign in to comment.