docs: add initial files for mkdocs support
This commit is contained in:
49
docs/_overrides/main.html
Normal file
49
docs/_overrides/main.html
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
<!--
|
||||||
|
Copyright (c) 2016-2022 Martin Donath <martin.donath@squidfunk.com>
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to
|
||||||
|
deal in the Software without restriction, including without limitation the
|
||||||
|
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
||||||
|
sell copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||||||
|
IN THE SOFTWARE.
|
||||||
|
-->
|
||||||
|
|
||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
<!-- Custom front matter -->
|
||||||
|
{% block extrahead %}
|
||||||
|
|
||||||
|
<!-- Extra style sheets (can't be set in mkdocs.yml due to content hash) -->
|
||||||
|
<link
|
||||||
|
rel="stylesheet"
|
||||||
|
href="{{ 'overrides/assets/stylesheets/main.css' | url }}"
|
||||||
|
/>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
<!-- Announcement bar -->
|
||||||
|
{% block announce %}
|
||||||
|
<a href="https://twitter.com/dokku">
|
||||||
|
For updates follow <strong>@dokku</strong> on
|
||||||
|
<span class="twemoji twitter">
|
||||||
|
{% include ".icons/fontawesome/brands/twitter.svg" %}
|
||||||
|
</span>
|
||||||
|
<strong>Twitter</strong>
|
||||||
|
</a>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
<!-- Theme-related JavaScript -->
|
||||||
|
{% block scripts %}
|
||||||
|
{{ super() }}
|
||||||
|
|
||||||
|
<!-- Extra JavaScript (can't be set in mkdocs.yml due to content hash) -->
|
||||||
|
<script src="{{ 'overrides/assets/javascripts/bundle.js' | url }}"></script>
|
||||||
|
{% endblock %}
|
||||||
0
docs/assets/extra.css
Normal file
0
docs/assets/extra.css
Normal file
78
mkdocs.yml
Normal file
78
mkdocs.yml
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
---
|
||||||
|
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
|
||||||
|
|
||||||
|
markdown_extensions:
|
||||||
|
- admonition
|
||||||
|
- attr_list
|
||||||
|
- footnotes
|
||||||
|
- md_in_html
|
||||||
|
- pymdownx.details
|
||||||
|
- pymdownx.emoji:
|
||||||
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
|
- pymdownx.highlight:
|
||||||
|
anchor_linenums: true
|
||||||
|
- pymdownx.inlinehilite
|
||||||
|
- pymdownx.snippets
|
||||||
|
- pymdownx.superfences
|
||||||
|
- pymdownx.tabbed:
|
||||||
|
alternate_style: true
|
||||||
|
- tables
|
||||||
|
|
||||||
|
repo_url: https://github.com/dokku/dokku
|
||||||
|
|
||||||
|
site_dir: site
|
||||||
|
site_name: Dokku Documentation
|
||||||
|
site_url: https://dokku.com/docs/
|
||||||
|
|
||||||
|
extra:
|
||||||
|
social:
|
||||||
|
- icon: fontawesome/solid/bug
|
||||||
|
link: https://github.com/dokku/dokku/issues
|
||||||
|
- icon: fontawesome/solid/cart-shopping
|
||||||
|
link: https://dokku.dpdcart.com/cart/add?product_id=217344&method_id=236878
|
||||||
|
version:
|
||||||
|
provider: mike
|
||||||
|
|
||||||
|
theme:
|
||||||
|
custom_dir: docs/_overrides
|
||||||
|
favicon: assets/favicons/favicon-96x96.png
|
||||||
|
features:
|
||||||
|
- navigation.instant
|
||||||
|
- navigation.sections
|
||||||
|
- navigation.tabs
|
||||||
|
- navigation.top
|
||||||
|
- search.highlight
|
||||||
|
homepage: https://dokku.com
|
||||||
|
icon:
|
||||||
|
admonition:
|
||||||
|
tip: fontawesome/solid/wand-magic-sparkles
|
||||||
|
logo: assets/dokku-logo.svg
|
||||||
|
name: material
|
||||||
|
palette:
|
||||||
|
# Palette toggle for light mode
|
||||||
|
- media: "(prefers-color-scheme: light)"
|
||||||
|
scheme: default
|
||||||
|
toggle:
|
||||||
|
icon: material/brightness-7
|
||||||
|
name: Switch to dark mode
|
||||||
|
|
||||||
|
# Palette toggle for dark mode
|
||||||
|
- media: "(prefers-color-scheme: dark)"
|
||||||
|
scheme: slate
|
||||||
|
toggle:
|
||||||
|
icon: material/brightness-4
|
||||||
|
name: Switch to light mode
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- search
|
||||||
|
- exclude:
|
||||||
|
glob:
|
||||||
|
- _build/Dockerfile
|
||||||
|
- _build/entrypoint
|
||||||
|
- _build/requirements.txt
|
||||||
|
- home.html
|
||||||
|
- template.html
|
||||||
|
|
||||||
|
extra_css:
|
||||||
|
- assets/extra.css
|
||||||
Reference in New Issue
Block a user