{"id":15017442,"url":"https://github.com/openssl/openssl-docs","last_synced_at":"2025-04-12T11:45:07.742Z","repository":{"id":247771261,"uuid":"826756545","full_name":"openssl/openssl-docs","owner":"openssl","description":"docs.openssl.org website generator","archived":false,"fork":false,"pushed_at":"2025-04-08T13:18:43.000Z","size":242892,"stargazers_count":7,"open_issues_count":1,"forks_count":8,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-04-11T01:42:47.241Z","etag":null,"topics":["documentation","mkdocs","openssl"],"latest_commit_sha":null,"homepage":"https://docs.openssl.org/","language":"HTML","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/openssl.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},"funding":{"custom":"https://openssl-foundation.org/sponsorship/"}},"created_at":"2024-07-10T10:09:33.000Z","updated_at":"2025-04-09T11:26:26.000Z","dependencies_parsed_at":"2024-07-12T16:24:26.013Z","dependency_job_id":"a50da189-aca3-44f5-adf1-9c8ae8f61eec","html_url":"https://github.com/openssl/openssl-docs","commit_stats":{"total_commits":69,"total_committers":3,"mean_commits":23.0,"dds":"0.42028985507246375","last_synced_commit":"0dcca5956723dfef2df9156c556723b3fa8ed33c"},"previous_names":["openssl/openssl-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openssl%2Fopenssl-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openssl%2Fopenssl-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openssl%2Fopenssl-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openssl%2Fopenssl-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openssl","download_url":"https://codeload.github.com/openssl/openssl-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248564303,"owners_count":21125406,"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","mkdocs","openssl"],"created_at":"2024-09-24T19:50:28.235Z","updated_at":"2025-04-12T11:45:07.717Z","avatar_url":"https://github.com/openssl.png","language":"HTML","funding_links":["https://openssl-foundation.org/sponsorship/"],"categories":[],"sub_categories":[],"readme":"[![Deploy site](https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml/badge.svg?branch=main)](https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml)\n\n# docs.openssl.org\n\nThe OpenSSL Documentation website is based on\n[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and\nthis repository contains the required configuration files and build scripts.\n`docs.openssl.org` is hosted on GitHub Pages.\n\n## Deployment\n\nThe website is automatically rebuilt on changes in `doc` directory of `openssl/openssl`. Then a\nnew commit is pushed to `gh-pages` branch which triggers\n[pages-build-deployment](https://github.com/openssl/openssl-docs/actions/workflows/pages/pages-build-deployment)\nGitHub Actions workflow.\n\nTo deploy documentation website manually trigger\n[Deploy site](https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml) GitHub\nActions workflow.\n\n## Local development\n\nAll required dependencies are packed into a container image `quay.io/openssl-ci/docs`.\nTo start playing around you can spin up a container and run commands:\n\n1. Clone the repository:\n\n    ```sh\n    git clone https://github.com/openssl/openssl-docs.git\n    ```\n\n2. Run the container:\n\n    ```sh\n    podman run -it -v $(pwd)/openssl-docs:/mnt -w /mnt -p 8000:8000 --userns=keep-id quay.io/openssl-ci/docs:latest bash\n    ```\n\n3. Build the docs:\n\n    ```sh\n    python build.py \u003cOPENSSL BRANCH\u003e\n    ```\n\n4. Run the development web server:\n\n    ```sh\n    mike serve -a 0.0.0.0:8000\n    ```\n\n## build.py\n\nA small wrapper script to clone a specific OpenSSL branch and build a documentation website with\n`mike`. Run it to build the website:\n\n```sh\npython build.py \u003cOPENSSL BRANCH\u003e\n```\n\n`mike` puts generated content into a separate branch `gh-pages`. Please refer `mike`\n[documentation](https://github.com/jimporter/mike) for the details.\n\n## hooks.py\n\nAll pre- and post- processing is done via `MkDocs` hooks. Please refer `MkDocs`\n[documentation](https://www.mkdocs.org/dev-guide/plugins/#events) for the details.\n\n\n## References\n\n- [MkDocs](https://www.mkdocs.org)\n- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)\n- [mike](https://github.com/jimporter/mike)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenssl%2Fopenssl-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenssl%2Fopenssl-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenssl%2Fopenssl-docs/lists"}