{"id":15775860,"url":"https://github.com/agentender/nxdoc","last_synced_at":"2025-05-07T01:43:31.663Z","repository":{"id":252012466,"uuid":"839152380","full_name":"AgentEnder/nxdoc","owner":"AgentEnder","description":"An Nx plugin to generate documentation for other nx plugins","archived":false,"fork":false,"pushed_at":"2025-01-15T16:07:10.000Z","size":1655,"stargazers_count":3,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-18T00:38:16.301Z","etag":null,"topics":["documentation","nx","nx-plugin"],"latest_commit_sha":null,"homepage":"http://craigory.dev/nxdoc/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgentEnder.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-07T04:32:16.000Z","updated_at":"2025-01-15T16:07:11.000Z","dependencies_parsed_at":"2024-08-07T07:03:18.295Z","dependency_job_id":"f09cf119-831f-4f1f-90fc-195f7d32e676","html_url":"https://github.com/AgentEnder/nxdoc","commit_stats":{"total_commits":25,"total_committers":1,"mean_commits":25.0,"dds":0.0,"last_synced_commit":"9af54a346addb7827fe7bde7c6c4585202d5aef9"},"previous_names":["agentender/nxdoc"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fnxdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fnxdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fnxdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentEnder%2Fnxdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgentEnder","download_url":"https://codeload.github.com/AgentEnder/nxdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252798537,"owners_count":21805876,"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","nx","nx-plugin"],"created_at":"2024-10-04T17:03:16.575Z","updated_at":"2025-05-07T01:43:31.643Z","avatar_url":"https://github.com/AgentEnder.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e This package is unstable! Documentation formatting could change in the future. See something that you think should be different? [Open an issue](https://github.com/agentender/nxdoc/issues) on github and help shape this plugin.\n\n\u003e [!NOTE]  \n\u003e This plugin was formerly published as @nx-dotnet/nxdoc. It was moved due to not being relevant to .NET and to decouple the releases. To view previous versions and changelogs checkout the [nx-dotnet repo](https://github.com/nx-dotnet/nx-dotnet)\n\n## Prerequisites\n\n- Have an existing nx workspace containing an Nx plugin project. For creating this, see [nrwl's documentation](https://nx.dev/latest/angular/getting-started/nx-setup).\n\n## Installation\n\n### NPM\n\n```shell\nnpm i --save-dev nxdoc\n```\n\n### PNPM\n\n```shell\npnpm i --save-dev nxdoc\n```\n\n### Yarn\n\n```shell\nyarn add --dev nxdoc\n```\n\n## Usage\n\nTo get started, run the following command to configure docs generation for your plugin project:\n\n```shell\nnx generate nxdoc:configuration --project=my-plugin\n```\n\nThis will add a target to your plugin's `project.json` file that will generate documentation for your plugin. You can then run the following command to generate the documentation:\n\n```shell\nnx run my-plugin:generate-docs\n```\n\nBy default, this will output the documentation to `docs/my-plugin`. You can customize this by passing the `outputDirectory` option to the `generate-docs` target. For example, if we only have one plugin in our workspace, we can output the documentation to the root of the workspace:\n\n```json\n{\n  \"targets\": {\n    \"generate-docs\": {\n      \"executor\": \"nxdoc:generate-docs\",\n      \"options\": {\n        \"project\": \"my-plugin\",\n        \"outputDirectory\": \"docs\",\n        \"root\": true\n      }\n    }\n  }\n}\n```\n\n### Multiple Project Documentation\n\nWhat if we have multiple plugins in our workspace? We can generate documentation for each plugin by creating a target for each plugin. For example, if we have two plugins, `my-plugin` and `my-other-plugin`, we can run the configuration generator for each. Then we can run the `generate-docs` target for each plugin:\n\n```shell\n\nnx generate nxdoc:configuration --project=my-plugin\nnx generate nxdoc:configuration --project=my-other-plugin\nnx run-many -t generate-docs\n```\n\nBy default, this will output the documentation to `docs/my-plugin` and `docs/my-other-plugin`. There will not be anything that ties the documentation together though. As such, we provide another executor / generator pair to generate a landing page for the documentation. You can either run this generator manually as below:\n\n```shell\nnx generate nxdoc:generate-index\n```\n\nor you can add it to a project's `project.json` file as a target:\n\n```json\n{\n  \"targets\": {\n    \"generate-index\": {\n      \"executor\": \"nxdoc:generate-index\"\n    }\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentender%2Fnxdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagentender%2Fnxdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentender%2Fnxdoc/lists"}