{ "info": { "author": "Axel Haustant", "author_email": "noirbizarre+github@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: System :: Software Distribution" ], "description": "Pelican FrontMark\n=================\n\n.. image:: https://travis-ci.org/noirbizarre/pelican-frontmark.svg?tag=1.2.0\n :target: https://travis-ci.org/noirbizarre/pelican-frontmark\n :alt: Build Status\n\n.. image:: https://coveralls.io/repos/github/noirbizarre/pelican-frontmark/badge.svg?tag=1.2.0\n :target: https://coveralls.io/github/noirbizarre/pelican-frontmark?tag=1.2.0\n :alt: Coverage Status\n\n.. image:: https://img.shields.io/pypi/l/pelican-frontmark.svg\n :target: https://pypi.python.org/pypi/pelican-frontmark\n :alt: License\n\n.. image:: https://img.shields.io/pypi/format/pelican-frontmark.svg\n :target: https://pypi.python.org/pypi/pelican-frontmark\n :alt: Format\n\n.. image:: https://img.shields.io/pypi/pyversions/pelican-frontmark.svg\n :target: https://pypi.python.org/pypi/pelican-frontmark\n :alt: Supported versions\n\n\n\nA Pelican CommonMark/Front Matter reader.\n\nThis reader marse Markdown files with YAML frontmatter headers and formatted using the CommonMark specifications.\n\n\nRequirements\n------------\n\nPelican FrontMark works with Pelican 3.7+ and Python 3.3+\n\nGetting started\n---------------\n\nInstall `pelican-frontmark` with pip:\n\n.. code-block:: shell\n\n pip install pelican-frontmark\n \n\n\nAnd enable the plugin in you `pelicanconf.py` (or any configuration file you want to use):\n\n.. code-block:: Python\n\n PLUGINS = [\n '...',\n 'frontmark',\n '...',\n ]\n \n\n\nFiles format\n------------\n\nFrontmark will only recognize files using `.md` extension.\n\nHere an article example:\n\n.. code-block:: \n\n ---\n title: My article title\n date: 2017-01-04 13:10\n modified: 2017-01-04 13:13\n tags:\n - tag 1\n - tag 2\n slug: my-article-slug\n lang: en\n category: A category\n authors: Me\n summary: Some summary\n status: draft\n \n custom:\n title: A custom metadata\n details: You can add any structured and typed YAML metadata\n \n ---\n \n My article content\n \n \n\n\nAdvanced configuration\n----------------------\n\nSyntax highlighting\n*******************\n\nBy default, `FrontMark` outputs code blocks in a standard html5 way,\nie. a `pre>code` block with a language class.\nThis allow to use any html5 syntax highlight JavaScript lib.\n\nYou can force Pygments usage to output html4 pre rendered syntax highlight\nby setting `FRONTMARK_PYGMENTS` to `True` for default parameters\nor manually setting it to a dict of Pygments HtmlRenderer parameters.\n\n.. code-block:: python\n\n FRONTMARK_PYGMENTS = {\n 'linenos': 'inline',\n }\n \n\n\nSettings\n********\n\n- **`FRONTMARK_PARSE_LITERAL`**: `True` by default. Set it to `False` if you don't want multiline string literals (`|`)\n to be parsed as markdown.\n\n- **`FRONTMARK_PYGMENTS`**: Not defined by default and output standard html5 code blocks.\n Can be set to `True` to force Pygments usage with default parameters or a `dict` of\n `Pygments parameters `_\n\n\nRegistering custom YAML types\n*****************************\n\nYou can register custom YAML types using the `frontmark_yaml_register` signal:\n\n.. code-block:: python\n\n from frontmark.signals import frontmark_yaml_register\n \n \n def upper_constructor(loader, noder):\n return loader.construct_scalar(node).upper()\n \n \n def register_upper(reader):\n return '!upper', upper_constructor\n \n \n def register():\n frontmark_yaml_register.connected(register_upper):\n \n\n\nTesting\n-------\n\nTo test the plugin against all supported Python versions, run tox:\n\n.. code-block:: shell\n\n tox\n \n\n\nTo test only within your current Python version with pytest:\n\n.. code-block:: shell\n\n pip install -e .[test] # Install with test dependencies\n pytest # Launch pytest test suite\n \n\n\nor let setuptools do the job:\n\n.. code-block:: shell\n\n python setup.py test\n \n\n\n\n.. _travis-badge: https://travis-ci.org/noirbizarre/pelican-frontmark.svg?tag=1.2.0\n.. _travis-badge-url: https://travis-ci.org/noirbizarre/pelican-frontmark\n.. _coveralls-badge: https://coveralls.io/repos/github/noirbizarre/pelican-frontmark/badge.svg?tag=1.2.0\n.. _coveralls-badge-url: https://coveralls.io/github/noirbizarre/pelican-frontmark?tag=1.2.0\n.. _license-badge: https://img.shields.io/pypi/l/pelican-frontmark.svg\n.. _license-badge-url: https://pypi.python.org/pypi/pelican-frontmark\n.. _format-badge: https://img.shields.io/pypi/format/pelican-frontmark.svg\n.. _format-badge-url: https://pypi.python.org/pypi/pelican-frontmark\n.. _python-version-badge: https://img.shields.io/pypi/pyversions/pelican-frontmark.svg\n.. _python-version-badge-url: https://pypi.python.org/pypi/pelican-frontmark\n.. _pygments-options: http://docs.getpelican.com/en/stable/content.html#internal-pygments-options\n\nChangelog\n=========\n\n1.2.0 (2018-09-08)\n------------------\n\n- Upgrade to CommonMark 0.8+\n- Drop support for Python version prior to 3.5\n\n1.1.0 (2017-01-22)\n------------------\n\n- Added `FRONTMARK_PYGMENTS` optionnal setting for Pygments rendering\n- Fix links handling (ie. `{filename}`...)\n\n1.0.1 (2017-01-08)\n------------------\n\n- Test and fix plugin registeration\n- Make version and description available at module level\n\n1.0.0 (2017-01-08)\n------------------\n\n- Initial release\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/noirbizarre/pelican-frontmark", "keywords": "pelican", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pelican-frontmark", "package_url": "https://pypi.org/project/pelican-frontmark/", "platform": "", "project_url": "https://pypi.org/project/pelican-frontmark/", "project_urls": { "Homepage": "https://github.com/noirbizarre/pelican-frontmark" }, "release_url": "https://pypi.org/project/pelican-frontmark/1.2.0/", "requires_dist": null, "requires_python": "", "summary": "CommonMark/Frontmatter reader for Pelican", "version": "1.2.0" }, "last_serial": 4251782, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "a3d4e759f0ab614ae5add9cd8c0979fa", "sha256": "a88bfd54c9ac01b064ed9f97b76087554de7efa2329ecdb4760962dd42f7843a" }, "downloads": -1, "filename": "pelican_frontmark-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a3d4e759f0ab614ae5add9cd8c0979fa", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 7077, "upload_time": "2017-01-08T16:20:42", "url": "https://files.pythonhosted.org/packages/c7/1d/e38adbd79f9925672fe16e21c00418d8c413cbc5e44669685f48e2584faf/pelican_frontmark-1.0.0-py2.py3-none-any.whl" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "6d4f137d7ec3f5132270e1ff61e35a37", "sha256": "56e2840c044eb429a6a424c413bb60da19416dc7001f5306d8bb82789d1d42a3" }, "downloads": -1, "filename": "pelican_frontmark-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6d4f137d7ec3f5132270e1ff61e35a37", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 7179, "upload_time": "2017-01-08T18:02:33", "url": "https://files.pythonhosted.org/packages/0c/bd/ad4376684a168c6674eeba5cc45740148350cb89f5ef23be54c172a01b7a/pelican_frontmark-1.0.1-py2.py3-none-any.whl" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "7ae3d9ff712f08afce428618cd7fbbea", "sha256": "6d23d28f2c34d64f5fe729aab777a3cdefb6d9b95615ce7baa53e4b4783d9b6c" }, "downloads": -1, "filename": "pelican_frontmark-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7ae3d9ff712f08afce428618cd7fbbea", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 9269, "upload_time": "2017-01-22T19:08:33", "url": "https://files.pythonhosted.org/packages/1b/32/7f1a620abbbba61045b8a047ccaaec3e1aec22bd92a0eb509a2c76e871a1/pelican_frontmark-1.1.0-py2.py3-none-any.whl" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "a14f0578eee1ec5dae7f4851dae1f6b4", "sha256": "da0e91747f06008f29ea833bef4b5fd99c55a87d36d698568ba4c026d4ec17b1" }, "downloads": -1, "filename": "pelican_frontmark-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a14f0578eee1ec5dae7f4851dae1f6b4", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 6534, "upload_time": "2018-09-08T15:23:33", "url": "https://files.pythonhosted.org/packages/55/f1/17a747bcbb20394df345f4c2895d0533badf1d47ca6f3bee0c7693dc0c88/pelican_frontmark-1.2.0-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a14f0578eee1ec5dae7f4851dae1f6b4", "sha256": "da0e91747f06008f29ea833bef4b5fd99c55a87d36d698568ba4c026d4ec17b1" }, "downloads": -1, "filename": "pelican_frontmark-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a14f0578eee1ec5dae7f4851dae1f6b4", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 6534, "upload_time": "2018-09-08T15:23:33", "url": "https://files.pythonhosted.org/packages/55/f1/17a747bcbb20394df345f4c2895d0533badf1d47ca6f3bee0c7693dc0c88/pelican_frontmark-1.2.0-py2.py3-none-any.whl" } ] }