https://github.com/lennon-c/sandbox_mkdocs

Personal tests using Mkdocs and co.
https://github.com/lennon-c/sandbox_mkdocs

mkdocs mkdocs-material mkdocstrings

Last synced: about 1 month ago
JSON representation

Personal tests using Mkdocs and co.

• Host: GitHub
• URL: https://github.com/lennon-c/sandbox_mkdocs
• Owner: lennon-c
• Created: 2024-11-11T13:15:34.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-29T18:26:24.000Z (about 1 month ago)
• Last Synced: 2024-11-29T19:32:21.545Z (about 1 month ago)
• Topics: mkdocs, mkdocs-material, mkdocstrings
• Language: Python
• Homepage: https://lennon-c.github.io/SandBox_Mkdocs/
• Size: 677 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: docs/README.md

Awesome Lists containing this project

README

        
Playground for testing options, plugins, formatting of:

- mkdocs

- mkdocs-material 

- mkdocstrings-python

- markdown-exec[ansi]

- mkdocs-open-in-new-tab

- mkdocs-callouts (disabled, used to allow Obsidian syntax for callouts)

Just a set of personal tests, to see what works and what does not. 

Showcased in this project's [documentation](https://lennon-c.github.io/SandBox_Mkdocs/)

## Adding python exec in Readme

I do not use an `index.md` file as the entry point for the website. Instead, I use a `README.md` file, which serves as both the homepage of the site and the documentation on GitHub, reducing boilerplate.

However, some markup features are not supported when the `README.md` file is viewed directly on GitHub.

For example, code execution does not work on GitHub:

The following code block is displayed but not executed on GitHub, whereas it is executed on the documentation site.

```python exec="true"  

print('***I am in README.md and in the Home page***')

```