{"id":15048590,"url":"https://github.com/clayrisser/sphinx-jekyll-builder","last_synced_at":"2025-04-10T01:24:20.578Z","repository":{"id":53730395,"uuid":"157612429","full_name":"clayrisser/sphinx-jekyll-builder","owner":"clayrisser","description":"sphinx builder that outputs jekyll compatible markdown files with frontmatter","archived":false,"fork":false,"pushed_at":"2023-07-13T06:20:17.000Z","size":1092,"stargazers_count":20,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T06:48:51.580Z","etag":null,"topics":["builder","docs","documentation","jekyll","markdown","md","python","restructuredtext","rst","sphinx"],"latest_commit_sha":null,"homepage":"https://codejam.ninja","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clayrisser.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-11-14T21:19:49.000Z","updated_at":"2025-03-29T10:46:33.000Z","dependencies_parsed_at":"2022-08-30T05:21:02.591Z","dependency_job_id":"b57ead5f-5c15-4543-8e21-b3a5b927428c","html_url":"https://github.com/clayrisser/sphinx-jekyll-builder","commit_stats":null,"previous_names":["codejamninja/sphinx-jekyll-builder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Fsphinx-jekyll-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Fsphinx-jekyll-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Fsphinx-jekyll-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clayrisser%2Fsphinx-jekyll-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clayrisser","download_url":"https://codeload.github.com/clayrisser/sphinx-jekyll-builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248138873,"owners_count":21053972,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["builder","docs","documentation","jekyll","markdown","md","python","restructuredtext","rst","sphinx"],"created_at":"2024-09-24T21:14:18.571Z","updated_at":"2025-04-10T01:24:20.540Z","avatar_url":"https://github.com/clayrisser.png","language":"Python","funding_links":["https://liberapay.com/codejamninja/donate"],"categories":[],"sub_categories":[],"readme":"# sphinx-jekyll-builder\n\n[![PyPI](https://img.shields.io/pypi/v/sphinx-jekyll-builder.svg?style=flat-square)](https://pypi.org/project/sphinx-jekyll-builder)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/sphinx-jekyll-builder.svg?style=flat-square)](https://pypi.org/project/sphinx-jekyll-builder)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-jekyll-builder.svg?style=flat-square)](https://pypi.org/project/sphinx-jekyll-builder)\n[![GitHub stars](https://img.shields.io/github/stars/codejamninja/sphinx-jekyll-builder.svg?style=flat-square\u0026label=Stars)](https://github.com/codejamninja/sphinx-jekyll-builder)\n\n\n![](assets/sphinx-jekyll-builder.png)\n\n\u003e sphinx builder that outputs jekyll compatible markdown files with frontmatter\n\nPlease ★ this repo if you found it useful ★ ★ ★\n\n\n## Features\n\n* Generates markdown\n* Supports frontmatter\n* Compatible with [jekyll](https://jekyllrb.com)\n* Compatible with [gatsby](https://www.gatsbyjs.org/)\n\n\n## Installation\n\n```sh\npip3 install sphinx-jekyll-builder\n```\n\n\n## Dependencies\n\n* [Python 3](https://www.python.org)\n\n\n## Usage\n\nLoad extension in configuration.\n\n_conf.py_\n```py\nextensions = [\n    'sphinx_jekyll_builder'\n]\n```\n\nIf using [recommonmark](https://github.com/rtfd/recommonmark), make sure you\nexplicitly ignore the build files as they will conflict with the system.\n\n_conf.py_\n```py\nexclude_patterns = [\n    'build/*'\n]\n```\n\nBuild jekyll files with Makefile\n\n```sh\nmake jekyll\n```\n\nBuild jekyll files with `sphinx-build` command\n\n```sh\ncd docs\nsphinx-build -M jekyll ./ build\n```\n\n\n## Support\n\nSubmit an [issue](https://github.com/codejamninja/sphinx-jekyll-builder/issues/new)\n\n\n## Screenshots\n\n[Contribute](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/CONTRIBUTING.md) a screenshot\n\n\n## Contributing\n\nReview the [guidelines for contributing](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/CONTRIBUTING.md)\n\n\n## License\n\n[MIT License](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/LICENSE)\n\n[Jam Risser](https://codejam.ninja) © 2018\n\n\n## Changelog\n\nReview the [changelog](https://github.com/codejamninja/sphinx-jekyll-builder/blob/master/CHANGELOG.md)\n\n\n## Credits\n\n* [Jam Risser](https://codejam.ninja) - Author\n* [Matthew Brett](https://github.com/matthew-brett/nb2plots/blob/master/nb2plots/doctree2md.py) - doctree2md\n\n\n## Support on Liberapay\n\nA ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.\n\n[Add some fuel](https://liberapay.com/codejamninja/donate) if you'd like to keep me going!\n\n[![Liberapay receiving](https://img.shields.io/liberapay/receives/codejamninja.svg?style=flat-square)](https://liberapay.com/codejamninja/donate)\n[![Liberapay patrons](https://img.shields.io/liberapay/patrons/codejamninja.svg?style=flat-square)](https://liberapay.com/codejamninja/donate)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclayrisser%2Fsphinx-jekyll-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclayrisser%2Fsphinx-jekyll-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclayrisser%2Fsphinx-jekyll-builder/lists"}