mkdocs.yml

#
# Copyright (C) 2016 DANS - Data Archiving and Networked Services (info@dans.knaw.nl)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

site_name: easy-bag-store
theme:
  name: dans
  disclaimer: false

repo_name: DANS-KNAW/easy-bag-store
repo_url: https://github.com/DANS-KNAW/easy-bag-store

nav:
  - Manual: index.md
  - Definitions: definitions.md
  - Tutorial: tutorial.md
  - HTTP API: to-api.md

plugins:
  - markdownextradata
  - search

extra:
  #TODO: aanvullen
  tutorial_vagrant_box: 'https://maven.dans.knaw.nl/releases/dans/knaw/nl/easy-bag-store-tutorial/2019-10-04/easy-bag-store-tutorial-2019-10-04.box'
  tutorial_sample_data: https://github.com/DANS-KNAW/easy-bag-store/raw/master/docs/res/sample.zip
  percent_encoding: https://tools.ietf.org/html/rfc3986#section-2.1
  bagit_java_github_repo: https://github.com/LibraryOfCongress/bagit-java
  easy_bag_index_repo: https://github.com/DANS-KNAW/easy-bag-index
  bagit_fetchtxt: https://tools.ietf.org/html/rfc8493#section-2.2.3
  bagit_valid: https://tools.ietf.org/html/rfc8493#section-3

markdown_extensions:
  - attr_list
  #- legacy_attr
  - admonition
  - codehilite:
      guess_lang: false
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: Dans-labs
      repo: mkdocs-dans
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde