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

feat: initial quickcode guide for deploying contract using hardhat or foundry #10

Merged
merged 13 commits into from
Apr 15, 2024
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
3 changes: 2 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
"MD034": false,
"MD024": false,
"MD022": false,
"MD023": false
"MD023": false,
"MD046": false
}
30 changes: 12 additions & 18 deletions app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,24 +102,18 @@ export default defineAppConfig({
edit: 'https://github.com/matter-labs/zksync-docs/edit/staging/content',
feedback: 'https://github.com/matter-labs/zksync-docs/issues/new?labels=documentation',
links: [
// {
// icon: 'i-heroicons-star',
// label: 'Star on GitHub',
// to: 'https://github.com/nuxt/ui',
// target: '_blank',
// },
// {
// icon: 'i-heroicons-book-open',
// label: 'Nuxt UI Pro docs',
// to: 'https://ui.nuxt.com/pro/guide',
// target: '_blank',
// },
// {
// icon: 'i-simple-icons-nuxtdotjs',
// label: 'Purchase a license',
// to: 'https://ui.nuxt.com/pro/purchase',
// target: '_blank',
// },
{
icon: 'i-heroicons-chat-bubble-oval-left-ellipsis-16-solid',
label: 'Chat on Discord',
to: 'https://join.zksync.dev/',
target: '_blank',
},
{
icon: 'i-heroicons-user-group-20-solid',
label: 'Developer Forum',
to: 'https://github.com/zkSync-Community-Hub/zkync-developers/discussions',
target: '_blank',
},
],
},
},
Expand Down
Binary file modified bun.lockb
Binary file not shown.
17 changes: 17 additions & 0 deletions components/content/CheckIcon.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<template>
<UIcon
name="i-heroicons-check-circle-16-solid"
class="mb-1 ml-2 h-4 w-4 align-middle text-green-600 opacity-85"
/>
</template>

<script setup lang="ts">
/**
* A super simple component that renders a check icon inline.
*
* ```
* example usage in markdown:
* :check-icon some text beside the icon
* ```
*/
</script>
6 changes: 4 additions & 2 deletions components/content/ContentSwitcher.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
defineProps<{
items: ContentSwitcherItem[];
}>();

const selectedIndex = ref(0);

function onTabChange(index: number) {
selectedIndex.value = index;
}
const route = useRoute();
// This splits the path into segments and takes the first one
// TODO: This is a temporary solution, we need to find a better way to get the base path
const basePath = route.path.split('/')[1];
</script>

<template>
Expand All @@ -25,7 +27,7 @@ const route = useRoute();
>
<ContentQuery
v-slot="{ data }"
:path="$route.path"
:path="basePath"
find="one"
:where="{ _partial: true, _path: { $icontains: item.partial } }"
>
Expand Down
51 changes: 51 additions & 0 deletions components/content/DropPanel/DropPanel.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<template>
<div class="-mt-6 flex w-full flex-col divide-y divide-gray-200 dark:divide-gray-800">
<HeadlessDisclosure
v-for="(tab, index) in tabs"
:key="index"
v-slot="{ open }"
>
<HeadlessDisclosureButton
class="focus-visible:ring-primary-500 dark:focus-visible:ring-primary-400 inline-flex w-full flex-shrink-0 items-center gap-x-1.5 rounded-none py-6 text-left text-lg font-medium text-gray-500 underline-offset-4 hover:text-gray-700 hover:no-underline focus:outline-none focus-visible:outline-0 focus-visible:ring-2 focus-visible:ring-inset disabled:cursor-not-allowed disabled:opacity-75 dark:text-gray-400 dark:hover:text-gray-200"
>
<UIcon
name="i-heroicons-chevron-down-20-solid"
class="h-5 w-5 flex-shrink-0 transform font-bold transition-transform duration-200"
:class="open ? '' : '-rotate-90'"
/>
<span class="text-gray-900 dark:text-white">{{ tab.label }}</span>
</HeadlessDisclosureButton>
<HeadlessDisclosurePanel class="py-4 pl-6 text-base text-gray-500 dark:text-gray-100">
<component :is="tab.component" />
</HeadlessDisclosurePanel>
</HeadlessDisclosure>
</div>
</template>

<script setup lang="ts">
/**
* An accordion style component that allows
* for multiple panels to be open at once.
*
* Use Panel component to slot in panels.
*/
import { useSlots, computed } from 'vue';

const slots = useSlots();

const tabs = computed(() => {
return (
slots.default?.().map((slot, index) => {
if (slot.props?.label === undefined) {
throw new Error(`DropPanel: Panel at index ${index} is missing a label prop.`);
} else {
return {
index,
label: slot.props.label,
component: slot,
};
}
}) || []
);
});
</script>
11 changes: 11 additions & 0 deletions components/content/DropPanel/Panel.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<ContentSlot :use="$slots.default" />
</template>

<script setup lang="ts">
/**
* A panel component that can be slotted into a DropPanel.
*
* Use the `label` prop to set the tab label on the drop panel.
*/
</script>
79 changes: 0 additions & 79 deletions content/10.getting-started/1.index.md

This file was deleted.

33 changes: 0 additions & 33 deletions content/10.getting-started/2.installation.md

This file was deleted.

Loading
Loading