{"id":13495822,"url":"https://github.com/swiftlang/swift-docc-render","last_synced_at":"2025-04-05T08:09:37.750Z","repository":{"id":36966097,"uuid":"387532899","full_name":"swiftlang/swift-docc-render","owner":"swiftlang","description":"Web renderer for Swift-DocC documentation.","archived":false,"fork":false,"pushed_at":"2024-09-03T22:59:35.000Z","size":3254,"stargazers_count":311,"open_issues_count":30,"forks_count":49,"subscribers_count":116,"default_branch":"main","last_synced_at":"2024-09-08T19:40:47.503Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swiftlang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"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":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-19T16:44:49.000Z","updated_at":"2024-09-05T20:28:15.000Z","dependencies_parsed_at":"2023-11-10T11:13:12.392Z","dependency_job_id":"323198f9-12a5-4334-a751-c0a3c7de1a6a","html_url":"https://github.com/swiftlang/swift-docc-render","commit_stats":null,"previous_names":["swiftlang/swift-docc-render","apple/swift-docc-render"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc-render","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc-render/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc-render/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swiftlang%2Fswift-docc-render/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swiftlang","download_url":"https://codeload.github.com/swiftlang/swift-docc-render/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305935,"owners_count":20917208,"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-07-31T19:01:38.590Z","updated_at":"2025-04-05T08:09:37.722Z","avatar_url":"https://github.com/swiftlang.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Swift-DocC-Render\n\nSwift-DocC-Render is a web Single Page Application (SPA) powered by [Vue.js](https://vuejs.org/) for creating rich code documentation websites. Pages and content are generated using render JSON data from DocC. It comes with a well suited design for documentation websites.\nSPAs are web apps that render dynamically at runtime entirely in the browser, using JavaScript.\n\n[Swift-DocC](https://github.com/apple/swift-docc) is a tool for building and previewing documentation, aimed at making it easy to generate reference documentation from frameworks and packages, as well as free-form articles and tutorials authored in Markdown. It produces a folder in the Documentation Archive format (extension `.doccarchive`), which contains a machine-readable output of the documentation as JSON data that Swift-DocC-Render uses to produce rendered documentation.\n\n## Getting Started\n\n\u003e Note: requires [Node.js](https://nodejs.org/en/download/) v18\n\u003e and [npm](https://www.npmjs.com/package/npm) v9.5. An easy way to set these up is to install\n\u003e [nvm](https://github.com/nvm-sh/nvm) and run `nvm install` from within the Swift-DocC-Render\n\u003e repository. To use these versions as the default, add `--default` to the installation command.\n\n1. **Download this repository and go to its folder**\n\n    ```shell\n    git clone https://github.com/apple/swift-docc-render.git\n    cd swift-docc-render\n    ```\n\n2. **Install dependencies**\n\n    ```shell\n    npm install\n    ```\n\n3. **Run a local server with hot reload at [localhost:8080](http://localhost:8080/)**\n\n    You may want to set a proxy to handle data requests while developing locally by setting the VUE_APP_DEV_SERVER_PROXY env variable to a documentation archive (.doccarchive or .docc-build) on your disk or served in a HTTP endpoint:\n\n    ```shell\n    VUE_APP_DEV_SERVER_PROXY=[path to documentation archive] npm run serve\n    ```\n\n    As an alternative you can just create a `.env.development.local` file on the root of the project to add the `VUE_APP_DEV_SERVER_PROXY` env variable so you don't have to set it in the `npm run serve` script each time.\n\n## Using Swift-DocC-Render to render documentation\n\nFollow [these steps](https://github.com/apple/swift-docc#using-docc-to-build-and-preview-documentation) to generate a documentation archive, set the path to your renderer and render locally your documentation using Swift-DocC-Render.\n\n## Rendering and building docs\n\nYou need to have [DocC](https://swift.org/documentation/docc) installed, in order to preview and build documentation. Read [Getting Started with Swift](https://www.swift.org/getting-started/) to learn more.\n\nTo preview the docs, run `npm run docs:preview`. This will spawn a preview server on http://localhost:8000/documentation/swiftdoccrender.\n\nTo build the docs, run `npm run docs:build`.\n\n## Bug Reports and Feature Requests\n\n### Submitting a Bug Report\n\nSwift-DocC-Render tracks all bug reports with [GitHub](https://github.com/apple/swift-docc-render/issues).\nWhen you submit a bug report we ask that you follow the\nSwift [Bug Reporting](https://swift.org/contributing/#reporting-bugs) guidelines\nand provide as many details as possible.\n\nIf you can confirm that the bug occurs when using the latest commit of Swift-DocC\nfrom the `main` branch (see [Building Swift-DocC-Render](/CONTRIBUTING.md#build-and-run-swift-docc-render)),\nthat will help us track down the bug faster.\n\n### Submitting a Feature Request\n\nFor feature requests, please feel free to create an issue\non [GitHub](https://github.com/apple/swift-docc-render/issues/new?assignees=\u0026labels=New+Feature\u0026projects=\u0026template=FEATURE_REQUEST.yml) with the `New Feature` type\nor start a discussion on the [Swift Forums](https://forums.swift.org/c/development/swift-docc).\n\nDon't hesitate to submit a feature request if you see a way\nSwift-DocC-Render can be improved to better meet your needs.\n\nAll user-facing features must be discussed\nin the [Swift Forums](https://forums.swift.org/c/development/swift-docc)\nbefore being enabled by default.\n\n## Contributing to DocC\n\nPlease see the [contributing guide](/CONTRIBUTING.md) for more information.\n\n\u003c!-- Copyright (c) 2021 Apple Inc and the Swift Project authors. All Rights Reserved. --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswiftlang%2Fswift-docc-render","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswiftlang%2Fswift-docc-render","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswiftlang%2Fswift-docc-render/lists"}