Skip to content

Commit

Permalink
Update MkDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
radcortez committed Jul 7, 2022
1 parent 1c0fbcb commit 60b6602
Show file tree
Hide file tree
Showing 8 changed files with 194 additions and 169 deletions.
11 changes: 5 additions & 6 deletions documentation/Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ verify_ssl = true
name = "pypi"

[packages]
mkdocs = ">=1.2.3"
mkdocs-macros-plugin = ">=0.6.3"
pyyaml = ">=6.0"
mike = ">=1.1.2"
mkdocs-material = ">=8.1.4"
mkdocs = "*"
mkdocs-material = "*"
mkdocs-macros-plugin = "*"
mike = "*"

[dev-packages]

[requires]
python_version = "3.9"
python_version = "3"
255 changes: 114 additions & 141 deletions documentation/Pipfile.lock

Large diffs are not rendered by default.

66 changes: 45 additions & 21 deletions documentation/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,41 +53,65 @@ copyright: >-
theme:
name: material
favicon: images/favicon.png
palette:
primary: blue grey
accent: blue
logo: assets/smallrye-icon.svg
font:
text: Red Hat Text
code: Ubuntu Mono
text: Roboto
code: JetBrains Mono
icon:
repo: fontawesome/brands/github
favicon: assets/favicon.ico
features:
- navigation.instant
- navigation.indexes
- navigation.sections
- navigation.tracking
# - navigation.expand
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue-grey
accent: red
toggle:
icon: material/lightbulb-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: orange
toggle:
icon: material/lightbulb-on
name: Switch to light mode

markdown_extensions:
- toc:
toc_depth: 3
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.snippets
permalink: '#'
- admonition
- abbr
- smarty
- attr_list
- def_list
- md_in_html
- meta
- tables
- pymdownx.betterem
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.highlight:
linenums: true
anchor_linenums: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.smartsymbols
- pymdownx.betterem
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg

extra_css:
- css/smallrye.css
- assets/extra.css

extra:
version:
Expand Down
1 change: 1 addition & 0 deletions documentation/src/main/docs/assets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* Add stuff here if required */
Binary file added documentation/src/main/docs/assets/favicon.ico
Binary file not shown.
21 changes: 21 additions & 0 deletions documentation/src/main/docs/assets/smallrye-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions documentation/src/main/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
hide:
- navigation
- toc
---

# SmallRye Config

**SmallRye Config** is a library that provides a way to configure applications, frameworks and containers. It is used
Expand Down
3 changes: 2 additions & 1 deletion documentation/src/main/macros/docissimo.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ def loadAttributes(env):
file = open(path)
var = yaml.load(file, Loader=yaml.FullLoader)
file.close()
env.variables['attributes'] = var['attributes']
if var is not None:
env.variables['attributes'] = var['attributes']
else:
print("Unable to import attributes - " + path + " does not exists")

Expand Down

0 comments on commit 60b6602

Please sign in to comment.