NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-21 11:37:21 -06:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Add admonition support for embedded docs

Browse Source
This commit is contained in:
Jeremy Stretch 2020-03-05 14:49:52 -05:00
parent 25f4cae3ff
commit 121c7ada1f
2 changed files with 56 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
netbox/project-static/css/base.css
View File

@ -234,6 +234,58 @@ table.report th a {
margin-bottom: 0; margin-bottom: 0;
} }
/* Admonition (docs) */
.admonition {
margin-bottom: 10px;
padding-bottom: 2px;
}
.admonition p {
padding: 0 12px;
}
.admonition pre {
margin: 0 12px 10px;
}
.admonition p.admonition-title {
color: rgb(255, 255, 255);
font-weight: bold;
padding: 4px 12px;
}
.admonition p.admonition-title::before {
content: "\f06a";
font-family: "FontAwesome";
margin-right: 4px;
}
/* Admonition - Note */
.admonition.note {
background-color: rgb(231, 242, 250);
}
.admonition.note .admonition-title {
background-color: rgb(106, 176, 222);
}
.admonition.note .admonition-title::before {
content: "\f05a";
}
/* Admonition - Warning */
.admonition.warning {
background-color: rgb(255, 237, 204);
}
.admonition.warning .admonition-title {
background-color: rgb(240, 179, 126);
}
.admonition.warning .admonition-title::before {
content: "\f06a";
}
/* Admonition - Danger */
.admonition.danger {
background-color: rgb(253, 243, 242);
}
.admonition.danger .admonition-title {
background-color: rgb(242, 159, 151);
}
.admonition.danger .admonition-title::before {
content: "\f071";
}
/* AJAX loader */ /* AJAX loader */
.loading { .loading {
position: fixed; position: fixed;

7
netbox/utilities/templatetags/helpers.py
View File

@ -63,8 +63,8 @@ def gfm(value):
# Strip HTML tags # Strip HTML tags
value = strip_tags(value) value = strip_tags(value)
# Render Markdown with GFM extension # Render Markdown with GitHub-flavored extension
html = markdown(value, extensions=['mdx_gfm']) html = markdown(value, extensions=['gfm'])
return mark_safe(html) return mark_safe(html)
@ -225,7 +225,8 @@ def get_docs(model):
with open(path) as docfile: with open(path) as docfile:
content = docfile.read() content = docfile.read()
content = markdown(content, extensions=['mdx_gfm']) # Render Markdown with GFM, admonition
content = markdown(content, extensions=['gfm', 'admonition'])
return mark_safe(content) return mark_safe(content)