Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:

- uses: actions/upload-pages-artifact@v3
with:
path: docs/site/.vitepress/dist
path: docs/site/dist

deploy:
environment:
Expand Down
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ Thumbs.db
.env.*.local

# Docs
docs/site/.vitepress/dist
docs/site/.vitepress/cache
docs/site/.astro/
docs/site/dist/
docs/site/node_modules/

# Debug
npm-debug.log*
Expand Down
2 changes: 2 additions & 0 deletions docs/site/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Use pre-built sharp binaries to avoid building from source
sharp_binary_mirror=https://ghcr.io/nicolo-ribaudo/sharp-prebuilds
96 changes: 0 additions & 96 deletions docs/site/.vitepress/config.ts

This file was deleted.

25 changes: 0 additions & 25 deletions docs/site/.vitepress/theme/custom.css

This file was deleted.

4 changes: 0 additions & 4 deletions docs/site/.vitepress/theme/index.ts

This file was deleted.

128 changes: 128 additions & 0 deletions docs/site/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";

const HOSTNAME = "https://dnlbox.github.io/fhir-capability-analyzer";
const DESCRIPTION =
"FHIR CapabilityStatement analyzer and comparator. Detect US Core, IPS, AU Core, and UK Core profiles. TypeScript CLI and library. CI-ready.";

export default defineConfig({
site: HOSTNAME,
base: "/fhir-capability-analyzer",
legacy: {
collections: true,
},
integrations: [
starlight({
title: "fhir-capability-analyzer",
description: DESCRIPTION,
social: [
{
icon: "github",
label: "GitHub",
href: "https://github.com/dnlbox/fhir-capability-analyzer",
},
{
icon: "npm",
label: "npm",
href: "https://www.npmjs.com/package/fhir-capability-analyzer",
},
],
editLink: {
baseUrl:
"https://github.com/dnlbox/fhir-capability-analyzer/edit/main/docs/site/",
},
customCss: [
"./src/theme/tokens/theme-blue.css",
"./src/theme/styles/base.css",
"./src/styles/custom.css",
],
sidebar: [
{
label: "Guide",
autogenerate: { directory: "guide" },
},
{
label: "Reference",
autogenerate: { directory: "reference" },
},
{
label: "Ecosystem",
link: "/ecosystem/",
},
],
head: [
{
tag: "meta",
attrs: { property: "og:type", content: "website" },
},
{
tag: "meta",
attrs: {
property: "og:site_name",
content: "fhir-capability-analyzer",
},
},
{
tag: "meta",
attrs: {
property: "og:title",
content: "fhir-capability-analyzer — FHIR CapabilityStatement analyzer CLI",
},
},
{
tag: "meta",
attrs: { property: "og:description", content: DESCRIPTION },
},
{
tag: "meta",
attrs: { property: "og:url", content: HOSTNAME + "/" },
},
{
tag: "meta",
attrs: { name: "twitter:card", content: "summary" },
},
{
tag: "meta",
attrs: {
name: "twitter:title",
content: "fhir-capability-analyzer — FHIR CapabilityStatement analyzer CLI",
},
},
{
tag: "meta",
attrs: { name: "twitter:description", content: DESCRIPTION },
},
{
tag: "meta",
attrs: {
name: "google-site-verification",
content: "Ffbl73Sm-TtkxrvNsLRS417HB-VjOPRmerHZVfhF0QQ",
},
},
{
tag: "script",
attrs: { type: "application/ld+json" },
content: JSON.stringify({
"@context": "https://schema.org",
"@type": "SoftwareApplication",
name: "fhir-capability-analyzer",
description: DESCRIPTION,
applicationCategory: "DeveloperApplication",
operatingSystem: "Any",
programmingLanguage: "TypeScript",
url: HOSTNAME + "/",
downloadUrl:
"https://www.npmjs.com/package/fhir-capability-analyzer",
license: "https://opensource.org/licenses/MIT",
codeRepository:
"https://github.com/dnlbox/fhir-capability-analyzer",
author: { "@type": "Person", name: "Daniel Veronez" },
}),
},
],
expressiveCode: {
themes: ["dark-plus", "github-light"],
},
}),
],
});
56 changes: 0 additions & 56 deletions docs/site/index.md

This file was deleted.

23 changes: 23 additions & 0 deletions docs/site/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "fhir-capability-analyzer-docs",
"version": "0.0.1",
"private": true,
"type": "module",
"scripts": {
"dev": "astro dev",
"build": "astro build",
"preview": "astro preview"
},
"dependencies": {
"@astrojs/starlight": "^0.34.8",
"@fontsource-variable/plus-jakarta-sans": "^5.2.8",
"@fontsource-variable/space-grotesk": "^5.2.10",
"@fontsource/ibm-plex-mono": "^5.2.7",
"astro": "^5.18.1",
"sharp": "^0.33.5"
},
"packageManager": "pnpm@11.1.3",
"engines": {
"node": ">=22.0.0"
}
}
6 changes: 6 additions & 0 deletions docs/site/src/content/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { defineCollection } from "astro:content";
import { docsSchema } from "@astrojs/starlight/schema";

export const collections = {
docs: defineCollection({ schema: docsSchema() }),
};
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Ecosystem
---
title: Ecosystem
description: How fhir-capability-analyzer fits into the fhir-toolkit suite of tools.
---

`fhir-capability-analyzer` is one of three complementary FHIR developer tools built to cover
the most common pain points in FHIR integration work.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Analyze a server
---
title: Analyze a Server
description: Fetch a FHIR server's CapabilityStatement and get a structured analysis report.
sidebar:
order: 2
---

The `analyze` command fetches a CapabilityStatement and produces a structured report.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# CI/CD integration
---
title: CI/CD Integration
description: Patterns for using fhir-capability-analyzer in CI pipelines and GitHub Actions.
sidebar:
order: 5
---

## Capability regression check

Expand Down
Loading
Loading