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
1 change: 0 additions & 1 deletion apps/www/content/docs/examples.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Start with an example
icon: FolderCode
description: Explore our collection of examples to get familiar with ArkEnv.
---

Expand Down
8 changes: 4 additions & 4 deletions apps/www/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: What is ArkEnv?
icon: Album
---

import { BookOpen, Github, Rocket } from "lucide-react";
import { BookOpen, Rocket, Globe } from "lucide-react";
import { SiGithub as GitHub } from "@icons-pack/react-simple-icons";

<include cwd>../../packages/arkenv/README.md#introduction</include>
Expand All @@ -12,7 +11,8 @@ import { SiGithub as GitHub } from "@icons-pack/react-simple-icons";
## Next steps

<Cards>
<Card icon={<Rocket />} title="Quickstart" href="/docs/quickstart" description="Quickly get started with ArkEnv in your project" />
<Card title="Quickstart" href="/docs/quickstart" description="Add ArkEnv to your existing project" />
<Card title="Start with an example" href="/docs/examples" description="Explore our collection of examples to start a new project" />
<Card icon={<GitHub />} title="ArkEnv on GitHub" href="https://github.com/yamcodes/arkenv" description="View the source code and contribute to the project" />
<Card icon={<BookOpen />} title="ArkType Documentation" href="https://arktype.io/docs" description="Learn more about the underlying type system" className="bg-blue-900" />
<Card icon={<Globe />} title="ArkType Documentation" href="https://arktype.io/docs" description="Learn more about the underlying type system" className="bg-blue-900" />
</Cards>
6 changes: 3 additions & 3 deletions apps/www/content/docs/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
"examples",
"---API---",
"morphs",
"---[New]Integrations---",
"[Blocks][VS Code & Cursor](/docs/integrations/vscode)",
"[Blocks][JetBrains IDEs](/docs/integrations/jetbrains)",
"---Integrations---",
"[VS Code & Cursor](/docs/integrations/vscode)",
"[JetBrains IDEs](/docs/integrations/jetbrains)",
"---How-to---",
"[Load environment variables](/docs/how-to/load-environment-variables)"
]
Expand Down
3 changes: 1 addition & 2 deletions apps/www/content/docs/morphs.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Morphs
icon: WandSparkles
icon: New
---

Since environment variables are defined as strings, ArkEnv automatically transforms certain ArkType keywords when imported through ArkEnv instead of directly from ArkType. These "morphs" provide environment-variable-specific behavior that's optimized for configuration management.
Expand All @@ -10,7 +10,6 @@ Since environment variables are defined as strings, ArkEnv automatically transfo
The `boolean` type automatically morphs (or coalesces) string values from environment variables to boolean.

```ts twoslash
// When using ArkEnv
import arkenv from 'arkenv';

const env = arkenv({ DEBUG: "boolean" });
Expand Down
16 changes: 5 additions & 11 deletions apps/www/content/docs/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Quickstart
icon: Rocket
description: Let's get you started with a few simple steps.
---

Expand Down Expand Up @@ -131,33 +130,28 @@ import { FolderCode, Blocks } from "lucide-react";
</Step>
</Steps>

Now you might start to see the :sparkles:_magic_:sparkles: of ArkType and TypeScript working together to make your environment variables more reliable, more readable, and more typesafe.

This is just the beginning of your ArkEnv journey. **Ready or not, it's time to dive in!** 🌊
Now you might start to see the magic of ArkType and TypeScript working together to make your environment variables more reliable, more readable, and more typesafe.

## Next steps

<Cards>
<Card
title="Integrate with VS Code & Cursor"
href="/docs/integrations/vscode"
icon={<Blocks />}
description="Get syntax highlighting and enhanced developer experience with the ArkType VS Code extension"
description="Get syntax highlighting, ErrorLens, and more"
/>
<Card
title="Integrate with JetBrains IDEs"
href="/docs/integrations/jetbrains"
icon={<Blocks />}
description="Get syntax highlighting and enhanced developer experience with the ArkType JetBrains IDEs extension"
description="Get syntax highlighting"
/>
<Card
title="Examples"
href="/docs/examples#examples"
icon={<FolderCode />}
description="See examples of ArkEnv in action"
description="Dive into ArkEnv with our collection of examples"
/>
<Card
title="Load environment variables"
title="How to load environment variables"
href="/docs/how-to/load-environment-variables"
description="Learn environment variables management in different environments and deployment scenarios"
/>
Expand Down
Loading