Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
py-quickstart/mkdocs.yml
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
94 lines (82 sloc)
3.54 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
site_name: Python for Hackers - Quick Start | |
nav: | |
- Introduction: index.md | |
- 'Version Control': './git/README.md' | |
- 'Development Environment': | |
- 'Introduction': './environment/index.md' | |
- 'Files and Execution': 'environment/files.md' | |
- 'Pip': 'environment/pip.md' | |
- 'Virtual Environments': 'environment/venv.md' | |
- 'Makefiles': 'environment/makefiles.md' | |
- 'Values and Types': 'values-and-types/README.md' | |
- 'Strings and Lists': 'strings-and-lists/README.md' | |
- 'Evaluation and Operators': 'evaluation-and-operators/README.md' | |
- 'Selection': 'selection/README.md' | |
- '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' | |
- 'Yield, map, lambda and generators': 'functions\yield_map_lambda\README.md' | |
- 'Interacting with the User': 'interaction/README.md' | |
- 'Working with Files': 'files/README.md' | |
- 'Testing': 'testing/README.md' | |
- 'Documentation': 'documentation/README.md' | |
- 'Representation of Data': 'data/README.md' | |
- 'Reading and Writing Files': 'files/README.md' | |
- 'Advanced input and output': 'advancedio/README.md' | |
- 'Algorithms': 'algorithms/README.md' | |
- 'Classes and Objects': 'oo/README.md' | |
- 'Designing Software': 'design/README.md' | |
- 'Interacting with the Network': 'network/README.md' | |
- 'Modules and Packages': 'modules/README.md' | |
- 'Abstract Data Structures': 'ads/README.md' | |
- 'Low-Level Programming': 'lowlevel/README.md' | |
markdown_extensions: | |
- admonition ## see: https://squidfunk.github.io/mkdocs-material/extensions/admonition/ for usage | |
- pymdownx.arithmatex: | |
generic: true | |
- pymdownx.details | |
- pymdownx.superfences | |
- pymdownx.emoji: | |
emoji_index: !!python/name:materialx.emoji.twemoji | |
emoji_generator: !!python/name:materialx.emoji.to_svg | |
- pymdownx.keys | |
- footnotes | |
- 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' | |
scheme: preference | |
custom_dir: 'mk_doc_ultra/custom_theme' | |
# 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 | |
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 |