Skip to content

Commit 55af76d

Browse files
committed
feat: inject into markdown as variable
fixes #2
1 parent fdf0360 commit 55af76d

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

mkdocs_git_revision_date_plugin/plugin.py

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
from mkdocs.config import config_options
44
from mkdocs.plugins import BasePlugin
55
from mkdocs.utils import string_types
6+
from jinja2 import Template
67
from .util import Util
78

89

910
class GitRevisionDatePlugin(BasePlugin):
1011
config_scheme = (
1112
('enabled_if_env', config_options.Type(string_types)),
13+
('modify_md', config_options.Type(bool, default=True))
1214
)
1315

1416
def __init__(self):
@@ -35,4 +37,19 @@ def on_page_markdown(self, markdown, page, config, files):
3537
print('WARNING - %s has no git logs, revision date defaulting to today\'s date' % page.file.src_path)
3638

3739
page.meta['revision_date'] = revision_date
38-
return markdown
40+
41+
if not self.config['modify_md']:
42+
return markdown
43+
44+
if 'macros' in config['plugins']:
45+
keys = list(config['plugins'].keys())
46+
vals = list(config['plugins'].values())
47+
if keys.index('macros') > vals.index(self):
48+
new_markdown = '{{% set git_revision_date = \'{}\' %}}\n'.format(revision_date) + markdown
49+
return new_markdown
50+
else:
51+
print('WARNING - macros plugin must be placed AFTER the git-revision-date plugin. Skipping markdown modifications')
52+
return markdown
53+
else:
54+
md_template = Template(markdown)
55+
return md_template.render({'git_revision_date': revision_date})

setup.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name='mkdocs-git-revision-date-plugin',
5-
version='0.1.4',
5+
version='0.1.5',
66
description='MkDocs plugin for setting revision date from git per markdown file.',
77
keywords='mkdocs git meta yaml frontmatter',
88
url='https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin/',
@@ -12,7 +12,8 @@
1212
python_requires='>=3.4',
1313
install_requires=[
1414
'mkdocs>=0.17',
15-
'GitPython'
15+
'GitPython',
16+
'jinja2'
1617
],
1718
packages=find_packages(),
1819
entry_points={

0 commit comments

Comments
 (0)