{"id":19416684,"url":"https://github.com/podium/graphql_markdown","last_synced_at":"2025-04-24T13:32:54.963Z","repository":{"id":57503287,"uuid":"407621205","full_name":"podium/graphql_markdown","owner":"podium","description":"A plugin for ex_doc to autogenerate Grapqhl documentation into ex_doc","archived":false,"fork":false,"pushed_at":"2024-10-14T14:37:29.000Z","size":95,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-10-29T08:44:51.837Z","etag":null,"topics":["documentation","elixir","elixir-lang","graphql"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/graphql_mardown","language":"Elixir","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/podium.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-17T17:09:42.000Z","updated_at":"2024-10-03T21:26:01.000Z","dependencies_parsed_at":"2023-11-09T01:30:43.377Z","dependency_job_id":"61ea1e47-15f9-472f-ba1b-a0004fc5c833","html_url":"https://github.com/podium/graphql_markdown","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/podium%2Fgraphql_markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/podium%2Fgraphql_markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/podium%2Fgraphql_markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/podium%2Fgraphql_markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/podium","download_url":"https://codeload.github.com/podium/graphql_markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223954837,"owners_count":17231189,"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":["documentation","elixir","elixir-lang","graphql"],"created_at":"2024-11-10T13:03:46.390Z","updated_at":"2024-11-10T13:03:46.976Z","avatar_url":"https://github.com/podium.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GraphqlMarkdown\n\nConverts a JSON Graphql Schema to Markdown\n\n## Installation\n\nIf [available in Hex](https://hex.pm/docs/publish), the package can be installed\nby adding `graphql_markdown` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:graphql_markdown, \"~\u003e 0.4.3\"}\n  ]\nend\n```\n\nAnd run:\n\n```shell\nmix deps.get\n```\n\nGenerate a single file called `graphql_schema.md` in the current dir:\n\n```shell\nmix graphql_gen_markdown -f ./schema.json\n```\n\n\nDocumentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)\nand published on [HexDocs](https://hexdocs.pm). Once published, the docs can\nbe found at [https://hexdocs.pm/graphql_markdown](https://hexdocs.pm/graphql_markdown).\n\n## Quick Start\n\nYou can generate either single page with all the types or a multipage that will then generate separately Mutations, Queries, Enums etc, each in a different file.\n\n### Single page\n\nWhen you run the following\n\n```shell\nmix graphql_gen_markdown -f ./schema.json\n```\nit will generate the following file in your current folder:\n\n./graphql_schema.md\n\nYou can change the default title for the single page with `-t` option.\n\n### Multi pages\n\nWhen you run the following\n\n```shell\nmix graphql_gen_markdown -f ./schema.json -m\n```\n\nit will generate the following files in your current folder:\n\n  ./queries.md\n  ./mutations.md\n  ./subscriptions.md\n  ./objects.md\n  ./inputs.md\n  ./enums.md\n  ./scalars.md\n  ./interfaces.md\n  ./unions.md\n\n## Integrate with ExDoc and Absinthe\n\nYou can easily automate the process with ExDoc by adding the following to your `mix.exs` file:\n\n```elixir\ndefmodule Azeroth.MixProject do\n  use Mix.Project\n\n  # this is needed because the file are generated but if you run mix docs, Mix will check the existence of files first. so have to work around that\n  @graphql_files [\n    \"guides/graphql/enums.md\",\n    \"guides/graphql/inputs.md\",\n    \"guides/graphql/interfaces.md\",\n    \"guides/graphql/mutations.md\",\n    \"guides/graphql/objects.md\",\n    \"guides/graphql/queries.md\",\n    \"guides/graphql/scalars.md\",\n    \"guides/graphql/unions.md\",\n    \"guides/graphql/subscriptions.md\"\n  ]\n  ...\n\n  defp aliases do\n  [\n    docs: [\n      \"absinthe.schema.json\",\n      \"graphql_gen_markdown -f schema.json -o guides/graphql -m\",\n      \"docs\"\n    ],...\n  ]\n```\n\nMake sure the absinthe schema is specified or generated with that name. Or add to your config.exs:\n\n```elixir\nconfig :absinthe, schema: YouApp.GraphQL.Schema\n```\n\n## Documentation\n\nDocumentation is [available on Hexdocs](https://hexdocs.pm/graphql_markdown/)\n\n## Contributing\n\n1. [Fork it!](http://github.com/podium/graphql_markdown/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## Author\n\nEmmanuel Pinault (@epinault)\n\n## License\n\nGraphqlMarkdown is released under the MIT License. See the [LICENSE.md](LICENSE.md) file for further details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpodium%2Fgraphql_markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpodium%2Fgraphql_markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpodium%2Fgraphql_markdown/lists"}