mkdocs.yml

site_name: Python for Hackers - Quick Start

nav:
  - Introduction: index.md
  - 'Version Control': 'git/'
  - 'Development Environment':
    - 'TODO - Files and Directories (types, shebang)': ./
    - 'TODO - Virtual Environments': ./
    - 'TODO - Makefiles': ./
    - 'TODO - Pip': ./
  - 'Values and Types': 'values-and-types/README.md'
  - 'Conditionals': 'conditionals/README.md'
  - 'Selection': 'selection/'
  - 'Iteration':
    - 'Introduction to iteration': 'iteration/intro-to-iteration.md'
    - 'For Loops': 'iteration/for-loops/README.md'
    - 'While Loops': 'iteration/while-loops/README.md'
    - 'Recursion': 'iteration/recursion/README.md'
  - 'Functions': 
    - 'Introduction to functions': 'functions/intro-to-functions.md'
    - 'User created functions': 'functions/user-functions/README.md'
    - 'Built-in functions': 'functions/built-in-functions/README.md'
  - 'Interacting with the User': 'interaction/'
  - 'Testing': 'testing/'
  - 'Documentation': 'documentation/'
  - 'Representation of Data': 'data/'
  - 'Reading and Writing Files': 'files/'
  - 'Algorithms': 'algorithms/'
  - 'Classes and Objects': 'oo/'
  - 'Interacting with the Network': 'network/'
  - 'Modules and Packages': 'modules/'
  - 'Abstract Data Structures': 'ads/'
  - 'Low-Level Programming': 'lowlevel/'

markdown_extensions:
  - admonition          ## see: https://squidfunk.github.io/mkdocs-material/extensions/admonition/ for usage 
  - codehilite:
      linenums: false    ## For line numbers in code blocks, true/false toggle
  # - footnotes
  # - meta


plugins:
  - search
  - macros:
      # module_name: './mk_doc_ultra/main.py'     ## it's not this
      # module_name: 'C:\Users\adzyb\Documents\Git\programming-resources\mk_doc_ultra\main.py'    ## it's not this either
      # module_name: '../mk_doc_ultra/main.py'    ## or this... or some variation 
      module_name: 'mk_doc_ultra.main'    ## Gottcha!! 
      include_dir: 'mk_doc_ultra/'    ## not sure what this does, but it's good syntax 


theme: 
  name: material
  custom_dir: 'mk_doc_ultra/'   ## Labels a custom directory that can contain modifications to the theme, js and css are auto loaded from here.
  logo: 'images/logo.svg'
  palette:
    primary: 'indigo'
    accent: 'indigo'
  # include_dir: 'mk_doc_ultra/'    ## don't know what it does but there is good syntax here and no errors
    

extra:
  draft: 1
  year: '2020/21'

extra_css: #['../../mk_doc_ultra/mk_ultra.css']
    - css/extra.css
    # - ../../mk_doc_ultra/mk_ultra.css
    - mk_ultra.css