From de5848513a1fecca4683ac4e952a6d5905af9831 Mon Sep 17 00:00:00 2001 From: Eduardo Blancas Date: Mon, 22 Apr 2024 22:41:24 -0600 Subject: [PATCH] adds sample project --- sample-mkdocs-project/docs/index.md | 19 +++++++++++++++++++ sample-mkdocs-project/mkdocs.yml | 20 ++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 sample-mkdocs-project/docs/index.md create mode 100644 sample-mkdocs-project/mkdocs.yml diff --git a/sample-mkdocs-project/docs/index.md b/sample-mkdocs-project/docs/index.md new file mode 100644 index 0000000..304662c --- /dev/null +++ b/sample-mkdocs-project/docs/index.md @@ -0,0 +1,19 @@ +--- +stuff: value +--- + +# Welcome to MkDocs + + + + +```python +print(1+1) +``` + +```python +import matplotlib.pyplot as plt + +plt.scatter([1, 2, 3], [1, 2, 3]) +``` \ No newline at end of file diff --git a/sample-mkdocs-project/mkdocs.yml b/sample-mkdocs-project/mkdocs.yml new file mode 100644 index 0000000..166828e --- /dev/null +++ b/sample-mkdocs-project/mkdocs.yml @@ -0,0 +1,20 @@ +site_name: My Docs +plugins: + - mkdocs-thebe: + baseUrl: http://localhost:5001 +theme: + name: material + features: + - content.code.copy + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + + # needed to enable the button that triggers the code execution + - attr_list \ No newline at end of file