# Test pluglet for mkdocs-macros
## What it is
This is a test **pluglet** for mkdocs-macros.
Its purpose is to serve as a template
for pluglets.
It exports three macros, which can be used in markdown pages, and aren't particularly
interesting:
- `test_fn(x:float)`: an arithmetic expression.
- `say_hello(s:str)`: displays Hello followed by the string, in italics.
- `test_fn2(s:str)`: same as `say_hello()`but does it slightly differently
For example, you could write:
He said {{ say_hello('Joe') }}.
Which will be translated into HTML as:
He said <i>Hello Joe</i>
## How to install it
Directly from pypi:
`pip install mkdocs-macros-test`
Or directly from the github repository: download
the package and run:
`python setup.py install`
## How to call it from an MkDocs project
In the config (`mkdocs.yml`) file:
```yaml
plugins:
- search
- macros:
modules: ['mkdocs_test`]
```
### Notes
https://github.com/fralau/mkdocs_macros_plugin
question - can this plugin be used to change the jinja2 environment that mkdocs uses?
use case:
i would like to be able to install a jinja2 extension and then use that extension in my custom mkdocs theme
in particular:
https://github.com/danielchatfield/jinja2_markdown
https://github.com/fralau/mkdocs_macros_plugin/blob/master/mkdocs_macros/plugin.py#L583
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-macros-test-ntno",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "documentation,mkdocs,theme",
"author": "Laurent Franceschetti",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c1/67/873cae37f316a1fb88da4373616b501d05305ce9e9f3bd550944b8e649f5/mkdocs_macros_test_ntno-0.0.0.tar.gz",
"platform": null,
"description": "# Test pluglet for mkdocs-macros\n\n## What it is\nThis is a test **pluglet** for mkdocs-macros.\nIts purpose is to serve as a template\nfor pluglets.\n\nIt exports three macros, which can be used in markdown pages, and aren't particularly\ninteresting:\n\n- `test_fn(x:float)`: an arithmetic expression.\n- `say_hello(s:str)`: displays Hello followed by the string, in italics.\n- `test_fn2(s:str)`: same as `say_hello()`but does it slightly differently\n\nFor example, you could write:\n\n He said {{ say_hello('Joe') }}.\n\nWhich will be translated into HTML as:\n\n He said <i>Hello Joe</i>\n\n## How to install it\n\nDirectly from pypi:\n`pip install mkdocs-macros-test`\n\nOr directly from the github repository: download\nthe package and run:\n`python setup.py install`\n\n## How to call it from an MkDocs project\n\nIn the config (`mkdocs.yml`) file:\n\n```yaml\nplugins:\n - search\n - macros:\n modules: ['mkdocs_test`] \n```\n\n\n### Notes\nhttps://github.com/fralau/mkdocs_macros_plugin\nquestion - can this plugin be used to change the jinja2 environment that mkdocs uses?\n\nuse case:\ni would like to be able to install a jinja2 extension and then use that extension in my custom mkdocs theme\n\nin particular: \nhttps://github.com/danielchatfield/jinja2_markdown\n\nhttps://github.com/fralau/mkdocs_macros_plugin/blob/master/mkdocs_macros/plugin.py#L583",
"bugtrack_url": null,
"license": "",
"summary": "Test macros library for macros plugin",
"version": "0.0.0",
"split_keywords": [
"documentation",
"mkdocs",
"theme"
],
"urls": [
{
"comment_text": "0.0.0",
"digests": {
"blake2b_256": "eee99769b871ee8698f40e89257490eea19b4ab8f9e45168fb75a4c5b3fdfba1",
"md5": "08edc34b16df6352e3b0696ca89a1870",
"sha256": "2b9abd19f9cf4c44830ae53d035b2a6fcabf4538a9931824bf6980702abd074e"
},
"downloads": -1,
"filename": "mkdocs_macros_test_ntno-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08edc34b16df6352e3b0696ca89a1870",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 3145,
"upload_time": "2023-01-17T01:31:08",
"upload_time_iso_8601": "2023-01-17T01:31:08.527829Z",
"url": "https://files.pythonhosted.org/packages/ee/e9/9769b871ee8698f40e89257490eea19b4ab8f9e45168fb75a4c5b3fdfba1/mkdocs_macros_test_ntno-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "0.0.0",
"digests": {
"blake2b_256": "c167873cae37f316a1fb88da4373616b501d05305ce9e9f3bd550944b8e649f5",
"md5": "4b69df91c56de79b13a525ea10533c48",
"sha256": "a99e6e617b354ba7adb7ac17b7d73ed804dc4cc3523f045c3d17e5cadc6f3988"
},
"downloads": -1,
"filename": "mkdocs_macros_test_ntno-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4b69df91c56de79b13a525ea10533c48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2914,
"upload_time": "2023-01-17T01:31:10",
"upload_time_iso_8601": "2023-01-17T01:31:10.669194Z",
"url": "https://files.pythonhosted.org/packages/c1/67/873cae37f316a1fb88da4373616b501d05305ce9e9f3bd550944b8e649f5/mkdocs_macros_test_ntno-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 01:31:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "mkdocs-macros-test-ntno"
}
JSON