{"id":18868460,"url":"https://github.com/pyscaffold/pyscaffoldext-markdown","last_synced_at":"2025-04-14T14:31:53.351Z","repository":{"id":32910840,"uuid":"145855057","full_name":"pyscaffold/pyscaffoldext-markdown","owner":"pyscaffold","description":"⬇️ PyScaffold extension which replaces reStructuredText by Markdown","archived":false,"fork":false,"pushed_at":"2025-03-03T17:03:05.000Z","size":134,"stargazers_count":13,"open_issues_count":6,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T03:51:13.436Z","etag":null,"topics":["markdown","pyscaffold","pyscaffold-extension","python"],"latest_commit_sha":null,"homepage":"https://pyscaffold.org","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/pyscaffold.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"FlorianWilhelm","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://www.paypal.me/FlorianWilhelm"}},"created_at":"2018-08-23T13:08:52.000Z","updated_at":"2025-03-25T05:32:05.000Z","dependencies_parsed_at":"2023-02-19T11:00:45.178Z","dependency_job_id":"3525f4ef-b3bf-4e08-a2a2-c37cd7318c76","html_url":"https://github.com/pyscaffold/pyscaffoldext-markdown","commit_stats":{"total_commits":134,"total_committers":9,"mean_commits":14.88888888888889,"dds":0.6044776119402986,"last_synced_commit":"06ac349b9b173edfffb9d83de9ba5ef2651f056a"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffoldext-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffoldext-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffoldext-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyscaffold%2Fpyscaffoldext-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyscaffold","download_url":"https://codeload.github.com/pyscaffold/pyscaffoldext-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248897231,"owners_count":21179562,"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":["markdown","pyscaffold","pyscaffold-extension","python"],"created_at":"2024-11-08T05:13:42.462Z","updated_at":"2025-04-14T14:31:53.061Z","avatar_url":"https://github.com/pyscaffold.png","language":"Python","funding_links":["https://github.com/sponsors/FlorianWilhelm","https://www.paypal.me/FlorianWilhelm"],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://api.cirrus-ci.com/github/pyscaffold/pyscaffoldext-markdown.svg?branch=master)](https://cirrus-ci.com/github/pyscaffold/pyscaffoldext-markdown)\n[![ReadTheDocs](https://readthedocs.org/projects/pyscaffoldext-markdown/badge/?version=latest)](https://pyscaffold.org/projects/markdown/en/latest/)\n[![Coveralls](https://img.shields.io/coveralls/github/pyscaffold/pyscaffoldext-markdown/master.svg)](https://coveralls.io/r/pyscaffold/pyscaffoldext-markdown)\n[![PyPI-Server](https://img.shields.io/pypi/v/pyscaffoldext-markdown.svg)](https://pypi.org/project/pyscaffoldext-markdown)\n[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/pyscaffoldext-markdown.svg)](https://anaconda.org/conda-forge/pyscaffoldext-markdown)\n[![Downloads](https://pepy.tech/badge/pyscaffoldext-markdown/month)](https://pepy.tech/project/pyscaffoldext-markdown)\n[![Sponsor](https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=ff69b4)](https://github.com/sponsors/FlorianWilhelm)\n\n\n# pyscaffoldext-markdown\n\n[PyScaffold] extension which replaces [reStructuredText] formatted files\nby [Markdown] format (with the help of [MyST]) except for [Sphinx]-related files.\n\n\n## Usage\n\nJust install this package with either `pip install pyscaffoldext-markdown` or `conda install -c conda-forge pyscaffoldext-markdown`\nand note that `putup -h` shows a new option `--markdown`.\nBasically this extension will replace `README.rst` by a proper `README.md` and\nactivate the support of Markdown files in Sphinx.\n\n\n## Building and Releasing\n\nBy default, the [tox] configuration generated by [PyScaffold] is compatible\nwith Markdown (as implemented in this extension). This means that (after\ninstalling [tox] with [pip] or [pipx]) you can run:\n\n```bash\ntox -e docs  # to build your documentation\ntox -e build  # to build your package distribution\ntox -e publish  # to test your project uploads correctly in test.pypi.org\ntox -e publish -- --repository pypi  # to release your package to PyPI\ntox -av  # to list all the tasks available\n```\n\nPlease remember that the command `python setup.py release` is no longer\nrecommended, so if you don't like [tox], please consider using\n[Sphinx] and [twine] directly:\n\n```bash\npython -m pip install -U pip setuptools wheel sphinx twine\npython setup.py bdist_wheel  # to build your package distributions\nmake -C docs html  # to build your docs\ntwine upload dist/*  # to release your package to PyPI\n```\n\n\u003c!-- pyscaffold-notes --\u003e\n\n## Making Changes \u0026 Contributing\n\nThis project uses [pre-commit], please make sure to install it before making any\nchanges:\n\n```bash\npip install pre-commit\ncd pyscaffoldext-markdown\npre-commit install\n```\n\nIt is a good idea to update the hooks to the latest version:\n\n```bash\npre-commit autoupdate\n```\n\nPlease also check PyScaffold's [contribution guidelines].\n\n\n## Note\n\nThis project has been set up using PyScaffold 4.0. For details and usage\ninformation on PyScaffold see [https://pyscaffold.org/](https://pyscaffold.org/).\n\n[PyScaffold]: https://pyscaffold.org\n[reStructuredText]: https://docutils.sourceforge.io/docs/user/rst/quickstart.html\n[Markdown]: https://daringfireball.net/projects/markdown/\n[MyST]: https://myst-parser.readthedocs.io/en/latest/index.html\n[Sphinx]: https://www.sphinx-doc.org/\n[WSL]: https://docs.microsoft.com/en-us/windows/wsl/\n[tox]: https://tox.readthedocs.org/\n[pip]: https://pip.pypa.io/en/stable/\n[pipx]: https://pipxproject.github.io/pipx/\n[twine]: https://twine.readthedocs.io/\n[PyPI]: https://pypi.org/\n[Conda-Forge]: https://anaconda.org/conda-forge/pyscaffoldext-markdown\n[pre-commit]: https://pre-commit.com/\n[contribution guidelines]: https://pyscaffold.org/en/latest/contributing.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyscaffold%2Fpyscaffoldext-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyscaffold%2Fpyscaffoldext-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyscaffold%2Fpyscaffoldext-markdown/lists"}