{"id":24587788,"url":"https://github.com/badrap/docs.badrap.io","last_synced_at":"2026-01-03T18:03:09.718Z","repository":{"id":39004773,"uuid":"143201629","full_name":"badrap/docs.badrap.io","owner":"badrap","description":"The docs.badrap.io experience™","archived":false,"fork":false,"pushed_at":"2025-01-21T09:31:32.000Z","size":15694,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-16T03:51:37.150Z","etag":null,"topics":["documentation","github-pages","security","vuepress"],"latest_commit_sha":null,"homepage":"https://docs.badrap.io","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/badrap.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":"docs/securitypolicy.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-01T19:47:17.000Z","updated_at":"2025-01-21T09:30:52.000Z","dependencies_parsed_at":"2024-04-18T07:38:22.886Z","dependency_job_id":"03dade6b-c4d0-45fc-9e55-98d951fcd612","html_url":"https://github.com/badrap/docs.badrap.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/badrap%2Fdocs.badrap.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badrap%2Fdocs.badrap.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badrap%2Fdocs.badrap.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badrap%2Fdocs.badrap.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badrap","download_url":"https://codeload.github.com/badrap/docs.badrap.io/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244102854,"owners_count":20398386,"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","github-pages","security","vuepress"],"created_at":"2025-01-24T07:13:10.283Z","updated_at":"2026-01-03T18:03:09.713Z","avatar_url":"https://github.com/badrap.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# The docs.badrap.io site [![build](https://github.com/badrap/docs/workflows/build/badge.svg)](https://github.com/badrap/docs/actions?query=workflow%3Abuild)\n\nThis is the repository for authoring and building content for the https://docs.badrap.io site.\n\nChanges to this repository's `main` branch get automatically built and deployed. The site is built using [VuePress](https://vuepress.vuejs.org/), the result is pushed to this repository's `gh-pages` branch from which [GitHub Pages](https://pages.github.com/) deploys it.\n\n## Development Quickstart\n\nIf you have Docker and Docker Compose installed, then you can run\n\n```sh\n$ docker compose up --build\n```\n\nAfter the initial compilation the site will be served on http://localhost:8080/. The repository root directory is mounted inside the dev build container, which should enable live reloads.\n\nYou can shut down the development environment by running\n\n```sh\n$ docker compose down -v\n```\n\n## Development Slow Start\n\n### Prerequisites\n\nAs a prerequisite for running the development environment you need to have [Node.js](https://nodejs.org) installed.\n\nOn the first run you need to install the dependencies (VuePress and whatnot) by running the following command in this repository:\n\n```\n$ npm install\n```\n\n### Start Development\n\nStart the development environment:\n\n```sh\n$ npm run dev\n```\n\nAfter a while you can open http://localhost:8080/ to see the current version of the site. The site also auto-updates when you edit the relevant files under `./docs`.\n\nBy default the development server binds to `localhost` port `8080`. This can be modified by setting the environment variables `HOST` and `PORT`:\n\n```sh\n$ HOST=192.168.0.1 PORT=3000 npm run dev\n```\n\n## Building for Production\n\nChanges to the `main` branch are deployed automatically. However, if you want to try building a production version of the site manually, the command is:\n\n```sh\n$ npm run build\n```\n\nIf the build is successful the results are located in the `./docs/.vuepress/dist` directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadrap%2Fdocs.badrap.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadrap%2Fdocs.badrap.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadrap%2Fdocs.badrap.io/lists"}