Mkdocs and Material¶
Common Links¶
Service Provider Pydantic Uvicore CLI SuperDict
Common names¶
yourname.yourapp
Common paragraphs¶
In order to use the database layer with Uvicore you must first ensure you have installed the database extras from the framework. This is by default already included in the uvicore-installer.
# Poetry pyproject.toml
uvicore = {version = "0.1.*", extras = ["database", "redis", "web"]}
# Pipenv Pipfile
uvicore = {version = "==0.1.*", extras = ["database", "redis", "web"]}
# requirements.txt
uvicore[database,redis,web] == 0.1.*
After the database extras have been installed you must update your config.package.py dependencies OrderedDict in config/package.py
'dependencies': OrderedDict({
'uvicore.foundation': {
'provider': 'uvicore.foundation.services.Foundation',
},
# ...
'uvicore.database': {
'provider': 'uvicore.database.services.Database',
},
# ...
}),
Admonitions¶
https://squidfunk.github.io/mkdocs-material/reference/admonitions/
Note
This is the !!! note admonition
Abstract
This is the !!! abstract admonition
Info
This is the !!! info admonition
Custom Title Here
This is the !!! info "Custom Title Here" admonition
Tip
This is the !!! tip admonition with a code block
def hi():
"""Code in a admonition provided by superfences"""
pass
No title use ""
Check
asdf
With title
Warning here
Danger
asdfasdfasdf asdf
Collapsible Admonition
Collapsible note Plus means default to open
Seealso
asdfasdfasdf asdf
Content Tabs¶
Example
do mac stuff
do linux stuff
Footnotes¶
Lorem ipsum1 dolor sit amet, consectetur adipiscing elit.2
Icons and Emojis¶
Smile Emoji 
See https://emojiguide.com/ or https://emojipedia.org for all emoji.
I use the twitter emoji
You can also just paste 🧒 emoji right in markdown. Or use things like 
This theme comes with these 3 FULL SETS of icons!
- –
.icons/material/account-circle.svg - :fontawesome-regular-laugh-wink: –
.icons/fontawesome/regular/laugh-wink.svg - :octicons-octoface-16: –
.icons/octicons/octoface-16.svg
Tasklist¶
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
- Vestibulum convallis sit amet nisi a tincidunt
- In hac habitasse platea dictumst
- In scelerisque nibh non dolor mollis congue sed et metus
- Praesent sed risus massa
- Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque