Merge pull request #69 from fluxcd/docs-meta
Add metadata to docs website
This commit is contained in:
BIN
docs/_files/toolkit-icon.png
Normal file
BIN
docs/_files/toolkit-icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
@@ -1,7 +1,7 @@
|
|||||||
site_name: GitOps Toolkit
|
site_name: GitOps Toolkit
|
||||||
site_description: Documentation for GitOps Toolkit.
|
site_description: A toolkit for assembling GitOps pipelines on Kubernetes
|
||||||
site_author: The Flux CD contributors
|
site_author: The Flux CD contributors
|
||||||
site_url: https://fluxcd.github.io/toolkit/
|
site_url: https://toolkit.fluxcd.io
|
||||||
|
|
||||||
repo_name: fluxcd/toolkit
|
repo_name: fluxcd/toolkit
|
||||||
repo_url: https://github.com/fluxcd/toolkit
|
repo_url: https://github.com/fluxcd/toolkit
|
||||||
@@ -14,6 +14,7 @@ theme:
|
|||||||
palette:
|
palette:
|
||||||
primary: blue
|
primary: blue
|
||||||
accent: indigo
|
accent: indigo
|
||||||
|
custom_dir: mkdocs/
|
||||||
|
|
||||||
docs_dir: docs
|
docs_dir: docs
|
||||||
|
|
||||||
@@ -25,6 +26,7 @@ plugins:
|
|||||||
|
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
|
- meta
|
||||||
- codehilite:
|
- codehilite:
|
||||||
guess_lang: false
|
guess_lang: false
|
||||||
- toc:
|
- toc:
|
||||||
|
|||||||
32
mkdocs/main.html
Normal file
32
mkdocs/main.html
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block extrahead %}
|
||||||
|
|
||||||
|
<meta property="og:url" content="{{ page.canonical_url }}">
|
||||||
|
{% if page and page.meta and page.meta.title %}
|
||||||
|
<meta property="og:title" content="{{ page.meta.title }}">
|
||||||
|
{% elif page and page.title and not page.is_homepage %}
|
||||||
|
<meta property="og:title" content="{{ page.title }} - {{ config.site_name }}">
|
||||||
|
{% else %}
|
||||||
|
<meta property="og:title" content="{{ config.site_name }}">
|
||||||
|
{% endif %}
|
||||||
|
<meta property="og:description" content="{{ config.site_description }}">
|
||||||
|
<meta property="og:image" content="https://toolkit.fluxcd.io/_files/toolkit-icon.png">
|
||||||
|
<meta property="og:image:alt" content="GitOps Toolkit">
|
||||||
|
<meta property="og:image:type" content="image/png">
|
||||||
|
|
||||||
|
<meta name="twitter:card" content="summary">
|
||||||
|
<meta name="twitter:site" content="@stefanprodan">
|
||||||
|
<meta name="twitter:creator" content="@stefanprodan">
|
||||||
|
{% if page and page.meta and page.meta.title %}
|
||||||
|
<meta property="twitter:title" content="{{ page.meta.title }}">
|
||||||
|
{% elif page and page.title and not page.is_homepage %}
|
||||||
|
<meta property="twitter:title" content="{{ page.title }} - {{ config.site_name }}">
|
||||||
|
{% else %}
|
||||||
|
<meta property="twitter:title" content="{{ config.site_name }}">
|
||||||
|
{% endif %}
|
||||||
|
<meta name="twitter:description" content="{{ config.site_description }}">
|
||||||
|
<meta name="twitter:image" content="https://toolkit.fluxcd.io/_files/toolkit-icon.png">
|
||||||
|
<meta name="twitter:image:alt" content="GitOps Toolkit">
|
||||||
|
|
||||||
|
{% endblock %}
|
||||||
Reference in New Issue
Block a user