Skip to content

Commit

Permalink
[docs] Add MkDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
kelvindecosta committed Jul 30, 2020
1 parent f656fe0 commit 2951e8f
Show file tree
Hide file tree
Showing 6 changed files with 168 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/assets/css/mkdocstrings.css
Original file line number Diff line number Diff line change
@@ -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;
}
Binary file added docs/assets/images/favicon.webp
Binary file not shown.
Binary file added docs/assets/images/logo.webp
Binary file not shown.
22 changes: 22 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -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 %}
<meta name="keywords" content="Text Art, Image Processing, ASCII Art, Figlet">
<meta property="og:type" content="website">
<meta property="og:title" content="{{ title }}">
<meta property="og:description" content="{{ config.site_description }}">
<meta property="og:url" content="{{ page.canonical_url }}">
<meta property="og:image" content="{{ image }}">
<meta property="og:image:type" content="image/webp">
<meta property="og:image:width" content="160">
<meta property="og:image:height" content="160">
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@_kelvindecosta">
<meta name="twitter:creator" content="@_kelvindecosta">
<meta name="twitter:title" content="{{ title }}">
<meta name="twitter:description" content="{{ config.site_description }}">
<meta name="twitter:image" content="{{ image }}">
{% endblock %}
27 changes: 27 additions & 0 deletions docs/overrides/partials/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{% import "partials/language.html" as lang with context %}

<!-- Application footer -->
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<!-- Copyright and theme information -->
<div class="md-footer-copyright">
{% if config.copyright %}
<div class="md-footer-copyright__highlight">
{{ config.copyright }}
</div>
{% endif %} Made with
<a
href="https://squidfunk.github.io/mkdocs-material/"
target="_blank"
rel="noopener"
>
Material for MkDocs
</a>
</div>

<!-- Social links -->
{% include "partials/social.html" %}
</div>
</div>
</footer>
86 changes: 86 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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 &copy; 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

0 comments on commit 2951e8f

Please sign in to comment.