{"id":18764471,"url":"https://github.com/theintern/theintern.github.io","last_synced_at":"2025-04-13T04:33:37.993Z","repository":{"id":27712803,"uuid":"31199868","full_name":"theintern/theintern.github.io","owner":"theintern","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-12T02:43:53.000Z","size":6470,"stargazers_count":0,"open_issues_count":22,"forks_count":8,"subscribers_count":7,"default_branch":"source","last_synced_at":"2024-04-09T22:20:58.964Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://theintern.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theintern.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-23T08:47:35.000Z","updated_at":"2022-03-31T15:16:58.000Z","dependencies_parsed_at":"2023-02-15T08:46:12.216Z","dependency_job_id":null,"html_url":"https://github.com/theintern/theintern.github.io","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/theintern%2Ftheintern.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theintern%2Ftheintern.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theintern%2Ftheintern.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theintern%2Ftheintern.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theintern","download_url":"https://codeload.github.com/theintern/theintern.github.io/tar.gz/refs/heads/source","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223568010,"owners_count":17166587,"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-07T18:29:56.606Z","updated_at":"2024-11-07T18:29:57.196Z","avatar_url":"https://github.com/theintern.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# The Intern website\n\n**Please note that the `master` branch contains the built website. Any PRs\nshould be made against the `source` branch.**\n\n## Doc viewer\n\nThe doc viewer is a single-page application that loads Markdown pages and API\ndata from GitHub and renders documentation on the fly. It must have, at a\nminimum, a list of project descriptors (described below) that describe where to\nload doc data from. These descriptors may also contain more detailed\ninformation, such as a list of pages to load. The viewer will first load a\nproject's README (this is assumed to always exist) and look for configuration\ndata. If any exists it is merged with the existing doc set descriptor, and any\ndoc pages or API data list in the descriptor are loaded and rendered.\n\n## Documentation descriptors\n\nProject documentation is described in `site/docs.json`. A project descriptor\ntypically looks like:\n\n```json\n{\n  \"url\": \"https://github.com/theintern/intern\",\n  \"latest\": \"3\",\n  \"next\": \"4\",\n  \"versions\": {\n    \"3\": {\n      \"branch\": \"3.4\"\n    },\n    \"4\": {\n      \"branch\": \"master\"\n    }\n  }\n}\n```\n\nThe entries in \"versions\" are individual doc sets, identified by the branch name\nand project URL. The doc set structures can also contain a page list and an API\ndoc location:\n\n```json\n{\n  \"branch\": \"master\",\n  \"pages\": [\"docs/intro.md\", \"docs/running.md\"],\n  \"api\": \"docs/api.json\"\n}\n```\n\nDoc set data can also be specified in the project README using HTML comments:\n\n```md\n# Intern\n\nIntern is great...\n\n\u003c!-- doc-viewer-config\n{\n    \"pages\": [\n\t\t\"docs/intro.md\",\n\t\t\"docs/running.md\"\n\t]\n}\n--\u003e\n```\n\nNote that the doc set descriptor shouldn't have a \"branch\" property when it's\nspecified in the README.\n\n## Developing\n\nFirst, run `npm install` to install dependencies.\n\nTo start a local testing server, run:\n\n```\nnpm start\n```\n\nTo build the site into `_public/`, run:\n\n```\nnpm run build\n```\n\nTo build a production version of the site with minified/inlined resources, run:\n\n```\nnpm run build production\n```\n\n## Publishing\n\nThe site source lives in the `source` branch, while the actual published code is\nin master. To publish an updated version of the site:\n\n```\nnpm run publish\n```\n\nThe `publish` script will clone this repo into the `public/` subdirectory and\ncheck out the `master` branch, build the site into it, commit the changes, and\npull those changes back into this instance of the repo, then push the changes to\norigin:master. If you'd like to publish to a branch other than origin, do\n\n```\nnpm run publish remote=my_remote\n```\n\nIf you'd like to skip the push step, do\n\n```\nnpm run publish remote=\n```\n\n## Credits\n\nThe Intern version badges were generated at https://shields.io with\nhttps://img.shields.io/badge/intern-v4-green.svg?colorB=2EC186.\n\n© [OpenJS Foundation](https://openjsf.org/) and its\n[contributors](https://github.com/theintern/intern/graphs/contributors)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheintern%2Ftheintern.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheintern%2Ftheintern.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheintern%2Ftheintern.github.io/lists"}