{"id":27610639,"url":"https://github.com/patternfly/patternfly-doc-core","last_synced_at":"2026-03-09T21:25:47.680Z","repository":{"id":264074406,"uuid":"892113579","full_name":"patternfly/patternfly-doc-core","owner":"patternfly","description":"Core documentation templates, helpers, and scaffolding for generating sites based on PatternFly.","archived":false,"fork":false,"pushed_at":"2026-02-27T08:03:39.000Z","size":2529,"stargazers_count":2,"open_issues_count":33,"forks_count":12,"subscribers_count":21,"default_branch":"main","last_synced_at":"2026-02-27T13:52:00.512Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patternfly.png","metadata":{"files":{"readme":"README.mdx","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-11-21T14:32:54.000Z","updated_at":"2026-02-04T23:18:16.000Z","dependencies_parsed_at":"2024-12-12T23:27:29.069Z","dependency_job_id":"ba96c495-b727-44a7-8e7c-b023fd275f64","html_url":"https://github.com/patternfly/patternfly-doc-core","commit_stats":null,"previous_names":["patternfly/patternfly-doc-core"],"tags_count":48,"template":false,"template_full_name":null,"purl":"pkg:github/patternfly/patternfly-doc-core","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly%2Fpatternfly-doc-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly%2Fpatternfly-doc-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly%2Fpatternfly-doc-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly%2Fpatternfly-doc-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patternfly","download_url":"https://codeload.github.com/patternfly/patternfly-doc-core/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly%2Fpatternfly-doc-core/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30312174,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T20:05:46.299Z","status":"ssl_error","status_checked_at":"2026-03-09T19:57:04.425Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["hacktoberfest"],"created_at":"2025-04-22T23:29:51.257Z","updated_at":"2026-03-09T21:25:47.668Z","avatar_url":"https://github.com/patternfly.png","language":"TypeScript","readme":"# Patternfly Documentation Core\n\nPatternfly documentation core contains the base packages needed to build and release the PatternFly org website.\n\n## Consuming this repo as a package\n\n### Setup\n\nUsing this package for your documentation is accomplished in just a few simple steps:\n\n1. Run `npx @patternfly/patternfly-doc-core@latest setup` from the root of your repo. This will:\n   - add the documentation core as a dependency in your package\n   - add the relevant scripts for using the documentation core to your package scripts\n   - create the configuration file for customizing the documentation core\n1. Install the documentation core using your projects dependency manager, e.g. `npm install` or `yarn install`\n1. Run the initialization script using your script runner, e.g. `npm run init:docs` or `yarn init:docs`\n   - this will update a Vite config in the documentation so that it can access the files in your repo when running the development server\n1. Edit the `pf-docs.config.mjs` file in your project root to point the documentation core to your documentation files\n\n### Use\n\nOnce setup is complete you can start the dev server with the `start` script, and create production builds using the `build:docs` script!\n\n## Running this repo directly\n\n### Development\n\nThe website is built using [Astro](https://astro.build). Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.\n\nThe `src/components/` folder contains Astro and React components that can be used to build the websites pages.\n\nAny static assets, like images, can be placed in the `public/` directory.\n\nTo define the markdown schema this project uses a typescript based schema known as [Zod](https://zod.dev). Details of how this is integratred into Astro can be found in Astros documentation on [content creation using Zod](https://docs.astro.build/en/guides/content-collections/#defining-datatypes-with-zod).\n\nNote: When running in dev mode locally on a clean repository, API endpoints will not be available until you run `npm run build` to generate the API index.\n### 🧞 Commands\n\nAll commands are run from the root of the project, from a terminal:\n\n| Command                   | Action                                                            |\n| :------------------------ | :-----------------------------------------------------------------|\n| `npm install`             | Installs dependencies                                             |\n| `npm run dev`             | Starts local dev server at `localhost:4321`                       |\n| `npm run build`           | Build your production site to `./dist/`                           |\n| `npm run preview`         | Preview your build locally, before deploying                      |\n| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check`                  |\n| `npm run astro -- --help` | Get help using the Astro CLI                                      |\n| `npm run build:cli`       | Create a JS build of the documentation core CLI                   |\n| `npm run build:cli:watch` | Run the CLI builder in watch mode                                 |\n| `npm run build:props`     | Create a json file of your TsDoc compatible in code documentation |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatternfly%2Fpatternfly-doc-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatternfly%2Fpatternfly-doc-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatternfly%2Fpatternfly-doc-core/lists"}