{"id":24990436,"url":"https://github.com/pivpn/docs","last_synced_at":"2025-10-29T19:32:15.921Z","repository":{"id":37801015,"uuid":"320696803","full_name":"pivpn/docs","owner":"pivpn","description":"pivpn documentation","archived":false,"fork":false,"pushed_at":"2025-03-10T19:13:52.000Z","size":377,"stargazers_count":35,"open_issues_count":0,"forks_count":17,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-10T19:43:59.547Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","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/pivpn.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":"2020-12-11T22:22:11.000Z","updated_at":"2025-03-10T19:13:59.000Z","dependencies_parsed_at":"2024-01-05T17:47:01.501Z","dependency_job_id":"b53cfea2-1942-456a-9dd4-9a857eb03d7c","html_url":"https://github.com/pivpn/docs","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pivpn%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pivpn%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pivpn%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pivpn%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pivpn","download_url":"https://codeload.github.com/pivpn/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246187210,"owners_count":20737459,"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":"2025-02-04T13:36:29.414Z","updated_at":"2025-10-29T19:32:15.839Z","avatar_url":"https://github.com/pivpn.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Pivpn Banner](docs/img/pivpnbanner.png)\n\n[![Deploy static content to Pages](https://github.com/pivpn/docs/actions/workflows/static.yml/badge.svg)](https://github.com/pivpn/docs/actions/workflows/static.yml)\n\n## Documentation \u0026 User Guides\n\nThis repo is the source for the official [PiVPN Documentation](https://docs.pivpn.io).\n\n### How to contribute\n\nPiVPN Documentation is powered by [MKDocs-Material](https://squidfunk.github.io/mkdocs-material/),\n\nPlease refer to [MKDocs Documentation](https://www.mkdocs.org/user-guide/) and [MKDocs-Material Documentation](https://squidfunk.github.io/mkdocs-material/) for more detailed information for information on how to install or more detailed documentation\n\nTo add a new link on the navigation panel you need to edit the `mkdocs.yml` file in the root of the repo. There is a guide for building the navbar at [mkdocs wiki](https://www.mkdocs.org/user-guide/configuration/#nav)\n\nTo add a new document\n\n- Navigate to the `docs/` directory\n- Create the file using a URL friendly filename.\n    EG. `docs/url-friendly.md` or `docs/guides/url-friendly.md`\n- Edit your document using Markdown, there are loads of resources available for the correct syntax.\n\n\n### Test your changes\n\nWhen working on this repo, it is advised that you review your changes locally before committing them. The `mkdocs serve` command can be used to live preview your changes (as you type) on your local machine.\n\n* Install [MKDocs-Material](https://squidfunk.github.io/mkdocs-material/getting-started/)\n* Fork the repo\n* clone it locally with `git clone https://github.com/YOUR-USERNAME/docs`\n* run `mkdocs serve`\n* open browser, and access `localhost:8000`\n* Make your changes and verify them live while you do them\n* Commit code `git commit -a`, make sure you add a nice message to your commit\n* Push code to your fork `git push origin master`\n* Make Pull Request\n\n### Deployment\n\nOnce changes are merged to master branch, CI Pipeline will run and take care of everything.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpivpn%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpivpn%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpivpn%2Fdocs/lists"}