Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #4

Merged
merged 47 commits into from
Mar 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
c71f6a5
docs: set up documentation (WIP)
jy95 Mar 27, 2024
92eaa83
chore: improve description
jy95 Mar 27, 2024
42eb9f3
ci: set up script
jy95 Mar 27, 2024
1a8f58d
chore: style
jy95 Mar 27, 2024
914c0e7
docs: add examples
jy95 Mar 27, 2024
c1f6790
chore: add examples
jy95 Mar 27, 2024
f41040d
chore: add examples
jy95 Mar 27, 2024
8a9f0a9
chore: add examples
jy95 Mar 27, 2024
ab2dab0
chore: add examples
jy95 Mar 27, 2024
8fdfbd4
docs: update readme
jy95 Mar 27, 2024
ded242d
chore: cache ignore
jy95 Mar 27, 2024
9aeeffe
chore: set up parcel
jy95 Mar 27, 2024
02ede58
chore: generate typings
jy95 Mar 27, 2024
6e32a90
chore: npm link
jy95 Mar 27, 2024
b4d42d4
docs: SingleDosageToText
jy95 Mar 27, 2024
e37feab
docs: clear types for component
jy95 Mar 28, 2024
bb7cd9e
docs: improve SingleDosageToText
jy95 Mar 28, 2024
79c4f28
docs: set up basic pages
jy95 Mar 28, 2024
78a626d
chore: copy assets
jy95 Mar 28, 2024
7fa6a04
chore: script
jy95 Mar 28, 2024
33b180c
chore: async refactoring
jy95 Mar 28, 2024
363f174
docs: refactor component
jy95 Mar 28, 2024
8b47fa2
docs: adding some pages
jy95 Mar 28, 2024
b88348e
docs: add more pages
jy95 Mar 28, 2024
e7d4a64
chore: add pages
jy95 Mar 29, 2024
bcca0d5
docs: add more pages
jy95 Mar 29, 2024
7da1b22
chore: add examples
jy95 Mar 29, 2024
947a1f5
chore: add examples
jy95 Mar 29, 2024
b69ff32
chore: add examples
jy95 Mar 29, 2024
fbc62c8
chore: add examples
jy95 Mar 29, 2024
ed7c5fc
chore: add examples
jy95 Mar 29, 2024
4041d33
perf: help webpack and other builders by typing for "Critical depende…
jy95 Mar 29, 2024
2e63bd6
perf: help webpack and other builders by typing for "Critical depende…
jy95 Mar 29, 2024
1996636
docs: put info
jy95 Mar 29, 2024
011ee17
docs: add info
jy95 Mar 29, 2024
46492c0
docs: add links
jy95 Mar 29, 2024
baa604b
docs: fix links
jy95 Mar 29, 2024
d131f7f
docs: add TypeDoc
jy95 Mar 29, 2024
2014606
docs: cleanup
jy95 Mar 29, 2024
18798ea
docs: update links
jy95 Mar 29, 2024
2c91152
docs: add Typedoc comments
jy95 Mar 30, 2024
978173d
docs: add enum with explanations
jy95 Mar 30, 2024
5036bda
docs: export enum so that TypeDoc can explain the display order properly
jy95 Mar 30, 2024
f05f146
docs: update docs
jy95 Mar 30, 2024
3322ba3
docs: customization examples
jy95 Mar 30, 2024
a1c2bc9
docs: finish custom examples
jy95 Mar 30, 2024
a726642
docs: add timing examples
jy95 Mar 30, 2024
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
Prev Previous commit
Next Next commit
docs: adding some pages
  • Loading branch information
jy95 committed Mar 28, 2024
commit 8b47fa2b6cb5ade5545e9c858520de17652111fe
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Multiple items
title: ➕ multiple items
title: ➕ Multiple items
---

import CodeBlock from "@theme/CodeBlock";
Expand All @@ -9,8 +9,6 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

# additionalInstruction (multiple items)

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Single item
title: ❌ single item
title: ❌ Single item
---

import CodeBlock from "@theme/CodeBlock";
Expand All @@ -9,8 +9,6 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

# additionalInstruction (single item)

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
Expand Down
7 changes: 7 additions & 0 deletions documentation/docs/specs/asNeeded/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "❓ asNeeded",
"link": {
"type": "generated-index",
"title": "❓ asNeeded showcases"
}
}
19 changes: 19 additions & 0 deletions documentation/docs/specs/asNeeded/asNeeded.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: asNeeded
title: 📌 asNeeded
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/asNeeded/asNeeded.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
19 changes: 19 additions & 0 deletions documentation/docs/specs/asNeeded/asNeededBoolean.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: asNeededBoolean
title: ✅ asNeededBoolean
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/asNeeded/asNeededBoolean.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
19 changes: 19 additions & 0 deletions documentation/docs/specs/asNeeded/asNeededCodeableConcept.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: asNeeded
title: 📌 asNeeded
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/asNeeded/asNeeded.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
19 changes: 19 additions & 0 deletions documentation/docs/specs/asNeeded/asNeededFor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: asNeededFor
title: 🧬 asNeededFor
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/asNeeded/asNeededFor.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
7 changes: 7 additions & 0 deletions documentation/docs/specs/boundsDuration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "🕰️ boundsDuration",
"link": {
"type": "generated-index",
"title": "🕰️ boundsDuration showcases"
}
}
19 changes: 19 additions & 0 deletions documentation/docs/specs/boundsDuration/boundsDuration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: boundsDuration
title: 🕰️ boundsDuration
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/boundsDuration/common.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
7 changes: 7 additions & 0 deletions documentation/docs/specs/boundsRange/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "📐 boundsRange",
"link": {
"type": "generated-index",
"title": "📐 boundsRange showcases"
}
}
19 changes: 19 additions & 0 deletions documentation/docs/specs/boundsRange/high_only.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: High only
title: 📐 boundsDuration (High only)
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/boundsRange/high_only.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
19 changes: 19 additions & 0 deletions documentation/docs/specs/boundsRange/low_and_high.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: Low & High
title: 📐 boundsDuration (Low & High)
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/boundsRange/low_and_high.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
19 changes: 19 additions & 0 deletions documentation/docs/specs/boundsRange/low_only.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: Low only
title: 📐 boundsDuration (Low only)
---

import CodeBlock from "@theme/CodeBlock";
import Schema from "@site/static/dosages/specs/boundsRange/low_only.json";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import SingleDosageToText from "@site/src/components/single_dosage_to_text";

<Tabs>
<TabItem value="text" label="Human readable text" default>
<SingleDosageToText dosage={Schema} />
</TabItem>
<TabItem value="json" label="Dosage">
<CodeBlock language="json">{JSON.stringify(Schema, null, 2)}</CodeBlock>
</TabItem>
</Tabs>
2 changes: 1 addition & 1 deletion documentation/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ module.exports = {
label: "💡 Demos",
link: {
type: "generated-index",
title: "💡 Showcases of the theme plugin",
title: "💡 Showcases of the library",
slug: "/demo",
},
items: [
Expand Down