{"id":18302316,"url":"https://github.com/outscale/osc-doc-framework","last_synced_at":"2025-10-10T21:13:24.811Z","repository":{"id":184166634,"uuid":"648663743","full_name":"outscale/osc-doc-framework","owner":"outscale","description":"osc-doc-framework is a framework used to generate OUTSCALE documentations","archived":false,"fork":false,"pushed_at":"2025-09-11T15:21:33.000Z","size":3073,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-09-11T18:32:03.432Z","etag":null,"topics":["maturity-graduated"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outscale.png","metadata":{"files":{"readme":"README.adoc","changelog":"CHANGELOG.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-02T13:54:00.000Z","updated_at":"2025-09-11T15:21:37.000Z","dependencies_parsed_at":"2023-10-04T14:30:45.583Z","dependency_job_id":"dc590136-0ea6-4b23-b712-b3c855291aa5","html_url":"https://github.com/outscale/osc-doc-framework","commit_stats":null,"previous_names":["outscale/osc-doc-framework"],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/outscale/osc-doc-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-doc-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-doc-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-doc-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-doc-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/osc-doc-framework/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-doc-framework/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005413,"owners_count":26083883,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["maturity-graduated"],"created_at":"2024-11-05T15:19:13.922Z","updated_at":"2025-10-10T21:13:24.769Z","avatar_url":"https://github.com/outscale.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"= osc-doc-framework\nifdef::env-github[]\n:tip-caption: :bulb:\n:note-caption: :information_source:\n:important-caption: :heavy_exclamation_mark:\n:caution-caption: :fire:\n:warning-caption: :warning:\nendif::[]\n\nimage:https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg[Project Graduated, link=\"https://docs.outscale.com/en/userguide/Open-Source-Projects.html\"]\n\n`osc-doc-framework` is a framework for generating OUTSCALE documentations, and most primarily the https://docs.outscale.com/[OUTSCALE Public Documentation]. It is based on the https://antora.org/[Antora] documentation site generator, with additional custom extensions designed to facilitate the work of technical writers.\n\nIn addition to the default Antora features, this framework enables the following:\n\n* API doc generation via https://github.com/Mermade/widdershins/[Widdershins] +\n* Prose linting and Style Guide validation via https://vale.sh/[Vale] +\n* Search engine via https://gitlab.com/antora/antora-lunr-extension[Antora Lunr Extension] +\n* Release note pages with clickable filters +\n* 404 page with randomized images +\n* RSS feed generation +\n* Automatic tooltips +\n* ...and more\n\n\n\n== Installing\n\nThere are multiple ways to install `osc-doc-framework` for your Antora documentation project. If you are an OUTSCALE technical writer, see the README of the internal `userguide` repository for team-specific instructions.\n\nOtherwise, see https://github.com/andrepasteur/antora-repo-example[antora-repo-example] for a working example.\n\n\n\n\n== Linting\n\nYou can configure your Git to use the pre-commit hook in the `git-hooks` folder. This pre-commit hook will run https://vale.sh/[Vale] on your the files of your Antora project in order to lint them with the Style Guide rules located in the `Vale/styles` directory.\n\n\n\n== Contributing\n\nFeel free to open an issue in case of bugs.\n\n\n\n== License\n\nCopyright OUTSCALE SAS\n\nMPL-2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-doc-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Fosc-doc-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-doc-framework/lists"}