diff --git a/docs/assets/css/mkdocstrings.css b/docs/assets/css/mkdocstrings.css new file mode 100644 index 0000000..a7054f5 --- /dev/null +++ b/docs/assets/css/mkdocstrings.css @@ -0,0 +1,33 @@ +div.doc-contents:not(.first) { + padding-left: 25px; + border-left: 4px solid rgba(230, 230, 230); + margin-bottom: 80px; +} + +h5.doc-heading { + text-transform: none !important; +} + +h6.hidden-toc { + margin: 0 !important; + position: relative; + top: -70px; +} + +h6.hidden-toc::before { + margin-top: 0 !important; + padding-top: 0 !important; +} + +h6.hidden-toc a.headerlink { + display: none; +} + +td code { + word-break: normal !important; +} + +td p { + margin-top: 0 !important; + margin-bottom: 0 !important; +} diff --git a/docs/assets/images/favicon.webp b/docs/assets/images/favicon.webp new file mode 100644 index 0000000..e660e93 Binary files /dev/null and b/docs/assets/images/favicon.webp differ diff --git a/docs/assets/images/logo.webp b/docs/assets/images/logo.webp new file mode 100644 index 0000000..d413052 Binary files /dev/null and b/docs/assets/images/logo.webp differ diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..b5b65c1 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,22 @@ +{#- + This file was automatically generated - do not edit + -#} + {% extends "base.html" %} + {% block extrahead %} + {% set image = config.site_url ~ config.extra.site_image %} + + + + + + + + + + + + + + + + {% endblock %} diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html new file mode 100644 index 0000000..84e6a98 --- /dev/null +++ b/docs/overrides/partials/footer.html @@ -0,0 +1,27 @@ +{% import "partials/language.html" as lang with context %} + + + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d03ac43 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,86 @@ +site_name: Picharsso +site_description: "A utility for converting images to text art." +site_author: "Kelvin DeCosta" +site_url: https://kelvindecosta.github.io/picharsso + +repo_name: kelvindecosta/picharsso +repo_url: https://github.com/kelvindecosta/picharsso +edit_uri: "" + +copyright: Copyright © 2019 Kelvin DeCosta + +theme: + name: material + custom_dir: docs/overrides + logo: assets/images/favicon.webp + palette: + primary: black + accent: light blue + font: + text: Nunito + code: Source Code Pro + favicon: assets/images/favicon.webp + include_search_page: false + search_index_only: true + +markdown_extensions: + - admonition + - codehilite: + guess_lang: false + - def_list + - meta + - pymdownx.betterem: + smart_enable: all + - pymdownx.details + - pymdownx.arithmatex: + generic: true + - pymdownx.smartsymbols + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.tabbed + - toc: + permalink: "#" + +plugins: + - search + - mkdocstrings: + handlers: + python: + rendering: + show_root_heading: false + show_root_toc_entry: false + - exclude: + glob: + - snippets/* + - minify: + minify_html: true + +extra: + social: + - icon: fontawesome/solid/globe + link: https://kelvindecosta.com + name: "Website" + - icon: fontawesome/brands/github + link: https://github.com/kelvindecosta + name: "GitHub" + - icon: fontawesome/brands/linkedin + link: https://linkedin.com/in/kelvindecosta + name: "LinkedIn" + - icon: fontawesome/brands/instagram + link: https://instagram.com/_kelvindecosta + name: "Instagram" + - icon: fontawesome/brands/twitter + link: https://twitter.com/_kelvindecosta + name: "Twitter" + - icon: fontawesome/solid/envelope + link: https://mailhide.io/e/c1R8e + name: "Mail" + site_image: assets/images/logo.webp + +extra_css: + - assets/css/mkdocstrings.css + +extra_javascript: + - javascripts/config.js + - https://polyfill.io/v3/polyfill.min.js?features=es6 + - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js