{"id":28951018,"url":"https://github.com/nrkno/core-docs","last_synced_at":"2025-11-08T06:04:45.634Z","repository":{"id":44909720,"uuid":"160354130","full_name":"nrkno/core-docs","owner":"nrkno","description":"Write documentation in markdown and render it beautifully","archived":false,"fork":false,"pushed_at":"2025-05-09T11:40:41.000Z","size":1158,"stargazers_count":4,"open_issues_count":11,"forks_count":2,"subscribers_count":65,"default_branch":"master","last_synced_at":"2025-06-16T12:56:10.603Z","etag":null,"topics":["documentation","markdown"],"latest_commit_sha":null,"homepage":"https://static.nrk.no/core-docs/latest/","language":"JavaScript","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/nrkno.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-12-04T12:29:12.000Z","updated_at":"2024-11-12T11:44:13.000Z","dependencies_parsed_at":"2024-10-21T09:06:17.087Z","dependency_job_id":null,"html_url":"https://github.com/nrkno/core-docs","commit_stats":{"total_commits":188,"total_committers":10,"mean_commits":18.8,"dds":0.7340425531914894,"last_synced_commit":"0ec320c1fc19eb812d8959d4d30198008221f339"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/nrkno/core-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrkno%2Fcore-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrkno%2Fcore-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrkno%2Fcore-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrkno%2Fcore-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nrkno","download_url":"https://codeload.github.com/nrkno/core-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nrkno%2Fcore-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261491821,"owners_count":23166678,"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","markdown"],"created_at":"2025-06-23T14:07:52.303Z","updated_at":"2025-11-08T06:04:45.607Z","avatar_url":"https://github.com/nrkno.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @nrk/core-docs\n\n\u003e `@nrk/core-docs` makes it easy to write documentation for your project in [markdown](https://github.com/markedjs/marked) and \nrender it beautifully.\n\n## Documentation\n\nhttps://static.nrk.no/core-docs/latest/\n\n## Getting started\n\ncore-docs can parse and render all markdown files you put in your repository. The only requirement is an `index.html` file which declares the menu as a `\u003cul\u003e` and loads the core-docs script. Link to your markdown files using their relative path, prepended with `?`. Example:\n\n```html\n\u003c!doctype html\u003e\n\u003chead\u003e\n  \u003cmeta charset=\"utf-8\"\u003e\n\u003c/head\u003e\n\u003cul\u003e\n  \u003cli\u003e\u003ca href=\"?readme.md\"\u003eCore Docs\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"?example/readme.md\"\u003eNested\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"?example/thing.md\"\u003eMore Docs\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cbr\u003e\u003ca href=\"https://github.com/nrkno/core-docs\"\u003eView on Github\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"https://github.com/nrkno/core-docs/releases\"\u003eView changelog\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#\" download\u003eDownload example\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cscript src=\"https://static.nrk.no/core-docs/major/4/core-docs.min.js\" charset=\"utf-8\"\u003e\u003c/script\u003e\n```\n## Local development\nFirst clone `@nrk/core-docs` and install its dependencies:\n\n```bash\ngit clone git@github.com:nrkno/core-docs.git\ncd core-docs\nnpm install\nnpm start # Your browser will open documentation with hot reloading\n```\n\n## Building and committing\nAfter having applied changes, remember to build before pushing the changes upstream.\n\n```bash\ngit checkout -b feature/my-changes\n# update the source code\nnpm run build\ngit commit -am \"Add my changes\"\ngit push origin feature/my-changes\n# then make a PR to the master branch,\n# and assign another developer to review your code\n```\n\n\u003e NOTE! Please also make sure to keep commits small and clean (that the commit message actually refers to the updated files).  \n\u003e Stylistically, make sure the commit message is **Capitalized** and **starts with a verb in the present tense** (for example `Add minification support`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnrkno%2Fcore-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnrkno%2Fcore-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnrkno%2Fcore-docs/lists"}