Skip to content

Commit

Permalink
Update mkdocs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
mdapena committed Dec 16, 2023
1 parent 04491e0 commit 15d1fd5
Showing 1 changed file with 47 additions and 36 deletions.
83 changes: 47 additions & 36 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Project information
site_name: Pyventus
site_description: A modern and robust Python package for event-driven programming. Define, emit, and orchestrate events with ease using customizable event emitters and flexible responses.
site_url: https://mdapena.github.io/pyventus/
site_author: Manuel Da Pena
site_description: >-
A modern and robust Python package for event-driven programming. Define, emit, and
orchestrate events with ease using customizable event emitters and flexible responses.
# Repository
repo_name: mdapena/pyventus
repo_url: https://github.com/mdapena/pyventus

# Copyright
copyright: |
Copyright &copy; 2023 <a href="https://github.com/mdapena" target="_blank" rel="mdapena">Manuel Da Pena</a>
# Configuration
theme:
name: material
language: en
Expand Down Expand Up @@ -36,32 +50,15 @@ theme:
- content.tooltips
- content.code.annotate

repo_name: mdapena/pyventus
repo_url: https://github.com/mdapena/pyventus

markdown_extensions:
- attr_list
- md_in_html
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path:
- !relative $docs_dir
- admonition
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.mark
- abbr
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
# Customization
extra:
social:
- icon: fontawesome/brands/linkedin
link: https://ve.linkedin.com/in/manuel-da-pena/en
- icon: fontawesome/brands/github
link: https://github.com/mdapena

# Plugins
plugins:
- search
- git-revision-date-localized:
Expand All @@ -88,7 +85,31 @@ plugins:
show_signature_annotations: true
show_category_heading: true

# Extensions
markdown_extensions:
- attr_list
- md_in_html
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path:
- !relative $docs_dir
- admonition
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.mark
- abbr
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true

# Page tree
nav:
- Pyventus: index.md
- Getting Started: getting-started.md
Expand All @@ -113,13 +134,3 @@ nav:
- RQ Event Emitter: api/emitters/rq-event-emitter.md
- Contributing: contributing.md
- Release Notes: release-notes.md

extra:
social:
- icon: fontawesome/brands/linkedin
link: https://ve.linkedin.com/in/manuel-da-pena/en
- icon: fontawesome/brands/github
link: https://github.com/mdapena

copyright: |
Copyright &copy; 2023 <a href="https://github.com/mdapena" target="_blank" rel="mdapena">Manuel Da Pena</a>

0 comments on commit 15d1fd5

Please sign in to comment.