{"id":20333355,"url":"https://github.com/bepinex/bepinex-docs","last_synced_at":"2025-03-04T12:46:00.652Z","repository":{"id":42451274,"uuid":"380195633","full_name":"BepInEx/bepinex-docs","owner":"BepInEx","description":"Documentation and API pages for BepInEx","archived":false,"fork":false,"pushed_at":"2024-10-06T16:40:13.000Z","size":1959,"stargazers_count":3,"open_issues_count":3,"forks_count":19,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-14T15:52:39.390Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.bepinex.dev","language":null,"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/BepInEx.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-06-25T09:55:12.000Z","updated_at":"2024-10-06T16:36:11.000Z","dependencies_parsed_at":"2024-07-10T00:13:43.518Z","dependency_job_id":"313472c7-5e58-4840-accf-2ab242926b30","html_url":"https://github.com/BepInEx/bepinex-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BepInEx%2Fbepinex-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BepInEx%2Fbepinex-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BepInEx%2Fbepinex-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BepInEx%2Fbepinex-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BepInEx","download_url":"https://codeload.github.com/BepInEx/bepinex-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241852142,"owners_count":20030969,"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":[],"created_at":"2024-11-14T20:30:59.395Z","updated_at":"2025-03-04T12:46:00.626Z","avatar_url":"https://github.com/BepInEx.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# BepInEx Documentation\n\nThis is the repo for storing documentation related to [BepInEx](https://github.com/BepInEx/BepInEx).  \n\n## [View the docs](https://docs.bepinex.dev/)\n\n## Contributing\n\nAll contributions either via PRs or issues are welcome!\n\nThis project uses [DocFX](https://dotnet.github.io/docfx/) to render the API documentation and the articles.  \nPlease refer to DocFX documentation for information on using [DocFX-flavoured markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a).\n\nIn general, you should be able to update pages with a simple markdown editor.\n\n### Testing docs locally\n\nIf you want to preview the docs locally, you need .NET 5 or newer installed.  \nAfter that, do the following:\n\n1. Clone this repo with `git clone`\n2. In the cloned directory, run\n    ```\n    git worktree add --checkout common common\n    ```\n    A folder named `common` should appear.\n2. Write documentation into `api` or `articles` folder. Refer to [docfx guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) and [DFM syntax guide](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html) for info on writing the guides using DocFX\n3. Run `common/build.bat --target=Build` to build the docs. The generated docs will appear in `_site` folder\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbepinex%2Fbepinex-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbepinex%2Fbepinex-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbepinex%2Fbepinex-docs/lists"}