feature(techdocs-core): Initial version of metadata generation of mkdocs data

This commit is contained in:
Sebastian Qvarfordt
2020-07-29 11:49:01 +02:00
parent 9d5f9132e9
commit 891b1cebb7
4 changed files with 16 additions and 6 deletions
+1 -1
View File
@@ -15,6 +15,6 @@
FROM python:3.7.7-alpine3.12
RUN apk update && apk --no-cache add gcc musl-dev
RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==0.0.2 mkdocs==1.1.2 mkdocs-material==5.3.2 mkdocs-monorepo-plugin==0.4.5 pymdown-extensions==7.1
RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==0.0.3 mkdocs==1.1.2 mkdocs-material==5.3.2 mkdocs-monorepo-plugin==0.4.5 pymdown-extensions==7.1
ENTRYPOINT [ "mkdocs" ]
@@ -1,4 +1,5 @@
site_name: 'mock-docs'
site_description: 'mock-docs site description'
nav:
- Home: index.md
@@ -18,7 +18,7 @@ from setuptools import setup, find_packages
setup(
name='mkdocs-techdocs-core',
version='0.0.2',
version='0.0.3',
description='A Mkdocs package that contains TechDocs defaults',
long_description='',
keywords='mkdocs',
@@ -16,16 +16,25 @@
from mkdocs.plugins import BasePlugin, PluginCollection
from mkdocs.theme import Theme
from mkdocs.contrib.search import SearchPlugin
from mkdocs_monorepo_plugin.plugin import MonorepoPlugin
import tempfile
import os
class TechDocsCore(BasePlugin):
def on_config(self, config):
fp = open(os.path.join(tempfile.gettempdir(), 'techdocs_metadata.json'), 'w+')
fp.write('{\n "site_name": "{{ config.site_name }}",\n "site_description": "{{ config.site_description }}"\n}')
# Theme
config["theme"] = Theme(name="material")
config["theme"] = Theme(
name="material",
static_templates=[
"techdocs_metadata.json",
],
)
config["theme"].dirs.append(tempfile.gettempdir())
# Plugins
del config["plugins"]["techdocs-core"]