mkdocs.yml

site_name: pytextrank
site_description: PyTextRank
site_url: https://github.com/DerwenAI/pytextrank
site_author: pytextrank contributors, with Derwen, Inc.

repo_url: https://github.com/DerwenAI/pytextrank
repo_name: DerwenAI/pytextrank

mkrefs_config: mkrefs.yml

copyright: Source code and documentation are <strong><a href="https://github.com/DerwenAI/pytextrank/blob/main/LICENSE" target="_blank">licensed</a></strong> under an MIT License; Copyright &copy; 2016-2021 <strong><a href="https://derwen.ai/" target="_blank">Derwen, Inc.</a></strong>

nav:
    - Home: index.md
    - User Guide:
        - Overview: overview.md
        - Getting Started: start.md
        - Package Reference: ref.md
        - Dependencies: depend.md
        - Build Instructions: build.md
        - Troubleshooting FAQ: faq.md
        - Project TODO List: todo.md
    - Tutorial:
        - Syllabus: tutorial.md
        - Setup: setup.md
        - Sample Usage: sample.md
        - TextRank algorithm explained: explain_algo.md
        - Extractive Summarization: explain_summ.md
        - Misc. Talks: talks.md
    - Glossary: glossary.md
    - Bibliography: biblio.md
    - Acknowledgements: ack.md

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  favicon: assets/favicon.png
  logo: assets/logo.png
  features:
    - navigation.instant

plugins:
  - git-revision-date
  - mknotebooks
  - mkrefs

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

use_directory_urls: true

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - toc:
      toc_depth: 3
      permalink: true