Skip to content

Commit

Permalink
Create a super basic mkdocs documentation setup
Browse files Browse the repository at this point in the history
  • Loading branch information
matentzn committed Oct 31, 2024
1 parent 5aae24d commit 6743308
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## RDA FAIR Mappings Working Group Documentation

Under construction.
3 changes: 3 additions & 0 deletions docs/usecases/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Use cases

Under construction.
57 changes: 57 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
site_name: RDA Fair Mappings Working Group
theme:
name: material
icon:
edit: material/pencil
features:
- content.action.edit
#- navigation.tabs
#- toc.integrate
#- navigation.sections
#- navigation.top
- search.suggest
- search.highlight
#- content.tabs.link
- content.code.annotation
- content.code.copy
- content.code.select
plugins:
- search
markdown_extensions:
- toc:
permalink: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.tabbed
- pymdownx.critic
- pymdownx.caret
- pymdownx.details
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- attr_list
- md_in_html
- pymdownx.highlight:
anchor_linenums: true
- admonition
- pymdownx.arithmatex:
generic: true
- footnotes
- attr_list
- md_in_html
- tables

extra_javascript:
- https://unpkg.com/[email protected]/dist/mermaid.min.js

nav:
- About the course: index.md
- Use cases: use_cases.md
repo_url: https://github.com/mapping-commons/rda-fair-mappings/
site_url: https://mapping-commons.github.io/rda-fair-mappings/
edit_uri: edit/main/docs/

0 comments on commit 6743308

Please sign in to comment.