{ "info": { "author": "Vincent Lunot", "author_email": "vlunot@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# nb2hugo\n\n*nb2hugo* is a simple way to convert a Jupyter notebook to a Hugo markdown page.\n\n\n## Motivation\n\nJupyter Notebook is a great way to create a single document that contains code that can be executed, formatted text to provide detailed explanations, as well as figures. Hugo is a simple yet very powerful static site generator. While a few solutions to convert a Jupyter notebook to a Hugo markdown with front matter already exist, *nb2hugo* put an emphasis on getting a result that looks similar to the original Jupyter notebook.\n\n\n## Installation\n\nUsing pip:\n```\npip install nb2hugo\n```\n\n\n## Usage\n\nIn your Jupyter notebook, start by using one or more markdown cells that will contain the front matter information. Next, add an html comment as a front matter divider: everything in the notebook before the End Of Front Matter divider `` will be the front matter. This approach is similar to the one used for [content summaries](https://gohugo.io/content-management/summaries/). \nA markdown title before the `` divider will automatically become the front matter title. You can also provide other front matter fields by writting pairs of \"key: value\" on different lines. \nBelow is an example of a notebook markdown cell that will become a front matter:\n\n```text\n# My notebook title\n\nDate: 2018-06-01 \nAuthor: firstname lastname \nCategories: category1, category2 \nTags: tag1, tag2, tag3 \n\n```\n\nAll content after the `` divider will be considered as normal notebook content.\n\nOnce you have finished writing your notebook, you can convert it using the following command:\n\n```bash\nnb2hugo notebook_file --site-dir hugo_website_directory --section content_section\n```\n\n\n## A workflow for easily publishing notebooks\n\nA [demo site](https://nb2hugo.netlify.com/) shows how to combine *nb2hugo*, Hugo and Netlify to easily blog with Jupyter notebooks. \nThe associated Git repository is available at .\n\n\n## Author\n\n**Vincent Lunot** - *Initial work*.\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.txt](https://github.com/vlunot/nb2hugo/blob/master/LICENSE.txt) file for details.\n\n\n## Acknowledgements\n\n*nb2hugo* is based on [nbconvert](https://github.com/jupyter/nbconvert).\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/vlunot/nb2hugo", "keywords": "jupyter notebook hugo converter", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "nb2hugo", "package_url": "https://pypi.org/project/nb2hugo/", "platform": "", "project_url": "https://pypi.org/project/nb2hugo/", "project_urls": { "Homepage": "http://github.com/vlunot/nb2hugo" }, "release_url": "https://pypi.org/project/nb2hugo/0.1.4/", "requires_dist": [ "nbconvert", "nbformat", "traitlets", "argparse", "pytest" ], "requires_python": ">=3.6", "summary": "A Jupyter notebook to Hugo markdown converter", "version": "0.1.4" }, "last_serial": 5153351, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "21876f25920811d1bd63cbcf3715d467", "sha256": "e3112f38e35702b39aeb36a791b765cba3e2d48b76f789e8c600e72bc9137d12" }, "downloads": -1, "filename": "nb2hugo-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "21876f25920811d1bd63cbcf3715d467", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 7837, "upload_time": "2018-08-17T18:26:43", "url": "https://files.pythonhosted.org/packages/00/ba/6b4047c4a1b3083cad9b1079be4dc9883b6c41ebcbdd39f4eb157b3a2cfc/nb2hugo-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "52ed5e966d05a2e9cbedb4f14b67e97d", "sha256": "cff239da93c24b0a383baec786ccc82011b2f6434fc55d7ef60de632164ded89" }, "downloads": -1, "filename": "nb2hugo-0.1.tar.gz", "has_sig": false, "md5_digest": "52ed5e966d05a2e9cbedb4f14b67e97d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6450, "upload_time": "2018-08-17T18:26:44", "url": "https://files.pythonhosted.org/packages/21/ef/69dbf424e85c6dfb355b214b62fd3d18b12e78a4c645c8590f0ca6be3ff4/nb2hugo-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "4ca8a1bfd7b6608cbe9319c5e97d70de", "sha256": "b457f7ef1d8c80f4665fb0a1cbe1872895937648006f7c42c2817da023d2faf5" }, "downloads": -1, "filename": "nb2hugo-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4ca8a1bfd7b6608cbe9319c5e97d70de", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 8706, "upload_time": "2019-04-12T01:40:21", "url": "https://files.pythonhosted.org/packages/6d/8a/d90f8d57f2d39bd30b74a7b8b72cc8f51c56ae977b6112a6cb63d4d2fe78/nb2hugo-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1df151a63bbf004b39f1f2aebaef3897", "sha256": "f8fccfc48f39824369867265c130d6dd1f538f7455f0577a47973ea0dc9677d7" }, "downloads": -1, "filename": "nb2hugo-0.1.1.tar.gz", "has_sig": false, "md5_digest": "1df151a63bbf004b39f1f2aebaef3897", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6493, "upload_time": "2019-04-12T01:40:24", "url": "https://files.pythonhosted.org/packages/d3/bb/ea8ba6902642ae0a535cc6c766b47e013248a821275fb536916068e6d5a2/nb2hugo-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "895f403a765e5ad9485350849a116cf0", "sha256": "cf5e7e631ce2ae323f6cd668467e574e7e3b6df8bcab63c2be6204aa31e55616" }, "downloads": -1, "filename": "nb2hugo-0.1.2-py2-none-any.whl", "has_sig": false, "md5_digest": "895f403a765e5ad9485350849a116cf0", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": ">=3.6", "size": 9643, "upload_time": "2019-04-15T13:34:00", "url": "https://files.pythonhosted.org/packages/ce/ad/49f3c2513a6d1067ae0bf67cf243b99af10b118b3608fcec751a3cbd6c2a/nb2hugo-0.1.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5856f49a2519c6aaa95c6456d8308a61", "sha256": "36eee6e12da4578bbcc66f010a56326bf8d652405ae72835a799344251a4172d" }, "downloads": -1, "filename": "nb2hugo-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5856f49a2519c6aaa95c6456d8308a61", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 8702, "upload_time": "2019-04-15T13:41:22", "url": "https://files.pythonhosted.org/packages/db/fe/3f2a20959089cea112d0cadbc3695f387b78246540d0f79e6858fac6f0f5/nb2hugo-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fe780c2b90f665bfb43b93122d75cb9e", "sha256": "2cf84d4d83fd1843279e77206f16802deb3d980002ae9b0a57cc5c59e330f3b7" }, "downloads": -1, "filename": "nb2hugo-0.1.2.tar.gz", "has_sig": false, "md5_digest": "fe780c2b90f665bfb43b93122d75cb9e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6499, "upload_time": "2019-04-15T13:34:04", "url": "https://files.pythonhosted.org/packages/0d/5e/a8c54738486db754b71c903515a7a202ec774e7f1c53b6aa7207317decf8/nb2hugo-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "522174c40f3f03b7727570632f7ca5c1", "sha256": "00d14c3eb5c7cfda083245678a367d6bced3c9b30623edc17b44c3f4a8f46006" }, "downloads": -1, "filename": "nb2hugo-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "522174c40f3f03b7727570632f7ca5c1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 8703, "upload_time": "2019-04-15T13:58:29", "url": "https://files.pythonhosted.org/packages/22/e8/35b5316133c0766cb744b71ddc41ad52cd9f86d1b57dce0a763afccea9a9/nb2hugo-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "94ad5d7e32a4cb04c8c721248ab5ddab", "sha256": "919ffd7f6c5c681e651bad43e9e1464fde637c3eed8797f4014d0c9f3aeec0c4" }, "downloads": -1, "filename": "nb2hugo-0.1.3.tar.gz", "has_sig": false, "md5_digest": "94ad5d7e32a4cb04c8c721248ab5ddab", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6495, "upload_time": "2019-04-17T05:22:18", "url": "https://files.pythonhosted.org/packages/8e/55/4c2490cfd9f970215eda826ed705ce61048b084e67859e814e485f88b067/nb2hugo-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "ecf905e80cfb045c016b3208b0000954", "sha256": "d9c2f1af0fa12a451f86609b9ccd8912eca363f0468d421b7fcb88f5147576dd" }, "downloads": -1, "filename": "nb2hugo-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "ecf905e80cfb045c016b3208b0000954", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 8832, "upload_time": "2019-04-17T05:20:57", "url": "https://files.pythonhosted.org/packages/f3/7a/2ab21f7aa06464e51618a0e1a0eaa4a0261e9dae79401b2550a5eac3385c/nb2hugo-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "81a445919810bb35719baafe20dbd388", "sha256": "bf735c8661c74762aa518399bde5da3308aa0efe5734c5e4b5c17cf4066515e2" }, "downloads": -1, "filename": "nb2hugo-0.1.4.tar.gz", "has_sig": false, "md5_digest": "81a445919810bb35719baafe20dbd388", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6648, "upload_time": "2019-04-17T05:22:19", "url": "https://files.pythonhosted.org/packages/a5/23/f9e0b8738281b7362176d0c1e1e23cceb6aaebdcae5c0bc6009800547734/nb2hugo-0.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ecf905e80cfb045c016b3208b0000954", "sha256": "d9c2f1af0fa12a451f86609b9ccd8912eca363f0468d421b7fcb88f5147576dd" }, "downloads": -1, "filename": "nb2hugo-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "ecf905e80cfb045c016b3208b0000954", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 8832, "upload_time": "2019-04-17T05:20:57", "url": "https://files.pythonhosted.org/packages/f3/7a/2ab21f7aa06464e51618a0e1a0eaa4a0261e9dae79401b2550a5eac3385c/nb2hugo-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "81a445919810bb35719baafe20dbd388", "sha256": "bf735c8661c74762aa518399bde5da3308aa0efe5734c5e4b5c17cf4066515e2" }, "downloads": -1, "filename": "nb2hugo-0.1.4.tar.gz", "has_sig": false, "md5_digest": "81a445919810bb35719baafe20dbd388", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 6648, "upload_time": "2019-04-17T05:22:19", "url": "https://files.pythonhosted.org/packages/a5/23/f9e0b8738281b7362176d0c1e1e23cceb6aaebdcae5c0bc6009800547734/nb2hugo-0.1.4.tar.gz" } ] }