Skip to content

Commit 5bd4fd1

Browse files
committed
Merge remote-tracking branch 'origin/migration' into feature/add-hello-world
2 parents ca2613d + 2e4239b commit 5bd4fd1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+594
-258
lines changed

.vitepress/config.mts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ import { transformerTwoslash } from '@shikijs/vitepress-twoslash';
22
import tailwindcss from '@tailwindcss/vite';
33
import { defineConfig } from 'vitepress';
44
import { getSidebar } from './sidebar';
5+
import {
6+
groupIconMdPlugin,
7+
groupIconVitePlugin,
8+
} from 'vitepress-plugin-group-icons';
59

610
// https://vitepress.dev/reference/site-config
711
export default defineConfig({
@@ -12,11 +16,14 @@ export default defineConfig({
1216
lastUpdated: true,
1317
ignoreDeadLinks: true,
1418
vite: {
15-
plugins: [tailwindcss()],
19+
plugins: [tailwindcss(), groupIconVitePlugin()],
1620
},
1721
srcDir: './src',
1822
markdown: {
1923
codeTransformers: [transformerTwoslash()],
24+
config(md) {
25+
md.use(groupIconMdPlugin);
26+
},
2027
},
2128

2229
head: [
@@ -77,10 +84,11 @@ export default defineConfig({
7784
themeConfig: {
7885
// https://vitepress.dev/reference/default-theme-config
7986
nav: [
80-
{ text: 'Home', link: '/' },
81-
{ text: 'Protect Data', link: '/manage-data/guides' },
82-
{ text: 'Build iApp', link: '/build-iapp/iapp-generator/what-is-iapp' },
87+
{ text: 'Overview', link: '/overview/welcome' },
88+
{ text: 'Protect Data', link: '/manage-data/what-is-protected-data' },
89+
{ text: 'Build iApp', link: '/build-iapp/what-is-iapp' },
8390
{ text: 'Use iApp', link: '/use-iapp/introduction' },
91+
{ text: 'Core Concept', link: '/core-concept/glossary' },
8492
],
8593
outline: {
8694
level: [2, 3],

.vitepress/sidebar.ts

Lines changed: 55 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@ import type { DefaultTheme } from 'vitepress';
22

33
export function getSidebar() {
44
return {
5-
'/': [
5+
'/overview/': [
66
{
77
text: 'OVERVIEW',
88
items: [
9-
{ text: '💡  What We Do', link: '/overview/what-we-do' },
9+
{ text: '💡 Welcome iExec', link: '/overview/welcome' },
1010
{
11-
text: '👋   Hello World',
11+
text: '👋 Hello World',
1212
link: '/overview/helloWorld',
13-
collapsed: true,
1413
items: [
1514
{
1615
text: 'iExec Overview',
@@ -20,10 +19,7 @@ export function getSidebar() {
2019
text: 'Protect data',
2120
link: '/overview/helloWorld/2-protectData',
2221
},
23-
{
24-
text: 'Build iApp',
25-
link: '/overview/helloWorld/3-buildIApp',
26-
},
22+
{ text: 'Build iApp', link: '/overview/helloWorld/3-buildIApp' },
2723
{
2824
text: 'Manage data access',
2925
link: '/overview/helloWorld/4-manageDataAccess',
@@ -35,13 +31,9 @@ export function getSidebar() {
3531
],
3632
},
3733
{
38-
text: '📋  Use Cases',
39-
collapsed: true,
34+
text: '📋 Use Cases',
4035
items: [
41-
{
42-
text: 'AI',
43-
link: '/overview/use-cases/ai',
44-
},
36+
{ text: 'AI', link: '/overview/use-cases/ai' },
4537
{
4638
text: 'Other Emerging Trends',
4739
link: '/overview/use-cases/other-emerging-trends',
@@ -64,26 +56,40 @@ export function getSidebar() {
6456
],
6557
},
6658
{
67-
text: '🤖  Use the docs in your AI',
59+
text: '🤖 Use the docs in your AI',
6860
link: '/overview/ai-integration',
6961
},
62+
{ text: '🆘 Contact Us', link: '/overview/contact-us' },
63+
],
64+
},
65+
{
66+
text: 'EXPLORERS',
67+
items: [
7068
{
71-
text: '🆘  Contact Us',
72-
link: '/overview/contact-us',
69+
text: 'the Explorer',
70+
collapsed: false,
71+
items: [
72+
{ text: 'iExec Explorer', link: '/overview/iexec-explorer' },
73+
{
74+
text: 'The Graph Explorer',
75+
link: '/overview/the-graph-explorer',
76+
},
77+
],
7378
},
7479
],
7580
},
81+
],
82+
'/manage-data/': [
7683
{
7784
text: 'PROTECT AND MANAGE DATA',
7885
items: [
7986
{
8087
text: '❓  What Is Protected Data?',
81-
link: '/manage-data/dataProtector/what-is-protected-data',
88+
link: '/manage-data/what-is-protected-data',
8289
},
8390
{
84-
text: '📖  Guides',
91+
text: '📖 Guides',
8592
link: '/manage-data/guides',
86-
collapsed: true,
8793
items: [
8894
{
8995
text: 'Create and Share Access to Protected Data',
@@ -100,14 +106,18 @@ export function getSidebar() {
100106
],
101107
},
102108
{
103-
text: '🔐&nbsp;&nbsp;DataProtector <span class="VPBadge warning" style="margin-left: 8px; margin-bottom: -1px; transform: translateY(-1px);">beta</span>',
109+
text: '🔐 DataProtector',
104110
link: '/manage-data/dataProtector',
105111
collapsed: true,
106112
items: [
107113
{
108114
text: 'Getting Started',
109115
link: '/manage-data/dataProtector/getting-started',
110116
},
117+
{
118+
text: 'Guides',
119+
link: '/manage-data/dataProtector/guides',
120+
},
111121
{
112122
text: 'DataProtector Core',
113123
link: '/manage-data/dataProtector/dataProtectorCore',
@@ -349,20 +359,19 @@ export function getSidebar() {
349359
},
350360
],
351361
},
362+
],
363+
'/build-iapp/': [
352364
{
353365
text: 'BUILD YOUR iAPP',
354366
items: [
367+
{ text: '❓ What Is an iApp?', link: '/build-iapp/what-is-iapp' },
355368
{
356-
text: '❓&nbsp;&nbsp;What Is an iApp?',
357-
link: '/build-iapp/iapp-generator/what-is-iapp',
358-
},
359-
{
360-
text: '📖&nbsp;&nbsp;Guides',
361-
collapsed: true,
369+
text: '📖 Guides',
370+
link: '/build-iapp/guides',
362371
items: [
363372
{
364373
text: 'Manage Your iApps',
365-
link: '/build-iapp/iapp-generator/manage-iapps',
374+
link: '/build-iapp/guides/manage-iapps',
366375
},
367376
{
368377
text: 'Orders (how they work, how to manage them)',
@@ -386,7 +395,7 @@ export function getSidebar() {
386395
},
387396
{
388397
text: 'AI Frameworks',
389-
link: '/build-iapp/iapp-generator/ai-frameworks',
398+
link: '/build-iapp/guides/ai-frameworks',
390399
},
391400
{
392401
text: 'Other Emerging Trends',
@@ -395,7 +404,7 @@ export function getSidebar() {
395404
],
396405
},
397406
{
398-
text: '🤖&nbsp;&nbsp;iApp Generator',
407+
text: '🤖 iApp Generator',
399408
link: '/build-iapp/iapp-generator',
400409
collapsed: true,
401410
items: [
@@ -418,26 +427,21 @@ export function getSidebar() {
418427
],
419428
},
420429
{
421-
text: '🔧&nbsp;&nbsp;Protocol-Level Guides',
430+
text: '🔧 Protocol-Level Guides',
422431
link: '/build-iapp/iapp-generator/protocol-level-guides',
423432
},
424433
],
425434
},
435+
],
436+
'/use-iapp/': [
426437
{
427438
text: 'USE AN iAPP',
428439
items: [
440+
{ text: '📝 Introduction', link: '/use-iapp/introduction' },
441+
{ text: '🚀 Getting Started', link: '/use-iapp/getting-started' },
429442
{
430-
text: '📝&nbsp;&nbsp;Introduction',
431-
link: '/use-iapp/introduction',
432-
},
433-
{
434-
text: '🚀&nbsp;&nbsp;Getting Started',
435-
link: '/use-iapp/getting-started',
436-
},
437-
{
438-
text: '📖&nbsp;&nbsp;Guides',
443+
text: '📖 Guides',
439444
link: '/use-iapp/guides',
440-
collapsed: true,
441445
items: [
442446
{
443447
text: 'Different ways to execute an iApp',
@@ -462,9 +466,8 @@ export function getSidebar() {
462466
],
463467
},
464468
{
465-
text: '💰&nbsp;&nbsp;How to Pay',
469+
text: '💰 How to Pay',
466470
link: '/use-iapp/payment',
467-
collapsed: true,
468471
items: [
469472
{
470473
text: 'How to Pay for Web3mail',
@@ -485,7 +488,7 @@ export function getSidebar() {
485488
],
486489
},
487490
{
488-
text: '✉&nbsp;&nbsp;Web3Mail',
491+
text: '✉ Web3Mail',
489492
link: '/use-iapp/web3mail',
490493
collapsed: true,
491494
items: [
@@ -518,7 +521,7 @@ export function getSidebar() {
518521
],
519522
},
520523
{
521-
text: '💬&nbsp;&nbsp;Web3Telegram <span class="VPBadge warning" style="margin-left: 8px; margin-bottom: -1px; transform: translateY(-1px);">alpha</span>',
524+
text: '💬 Web3Telegram <span class="VPBadge warning" style="margin-left: 8px; margin-bottom: -1px; transform: translateY(-1px);">alpha</span>',
522525
link: '/use-iapp/web3telegram',
523526
collapsed: true,
524527
items: [
@@ -555,7 +558,7 @@ export function getSidebar() {
555558
],
556559
},
557560
{
558-
text: '🧙&nbsp;&nbsp;Oracle Factory',
561+
text: '🧙 Oracle Factory',
559562
link: '/use-iapp/oracle-factory',
560563
collapsed: true,
561564
items: [
@@ -589,20 +592,22 @@ export function getSidebar() {
589592
},
590593
],
591594
},
595+
],
596+
'/core-concept/': [
592597
{
593-
text: 'KEY CONCEPTS',
598+
text: 'CORE CONCEPTS',
594599
items: [
595600
{
596601
text: '🔧&nbsp;&nbsp;iExec SDK',
597-
link: '/deep-dive/sdk',
602+
link: '/core-concept/sdk',
598603
},
599604
{
600605
text: '⚙️&nbsp;&nbsp;Workers & Workerpools',
601-
link: '/deep-dive/workers',
606+
link: '/core-concept/workers',
602607
},
603608
{
604609
text: '📖&nbsp;&nbsp;Glossary',
605-
link: '/deep-dive/glossary',
610+
link: '/core-concept/glossary',
606611
},
607612
],
608613
},

.vitepress/theme/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ import TwoslashFloatingVue from '@shikijs/vitepress-twoslash/client';
55
import Layout from './Layout.vue';
66
import type { EnhanceAppContext } from 'vitepress';
77
import googleAnalytics from 'vitepress-plugin-google-analytics';
8+
import 'virtual:group-icons.css';
9+
import '@shikijs/vitepress-twoslash/style.css';
810
import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query';
911
import { WagmiPlugin } from '@wagmi/vue';
1012
import { wagmiAdapter } from '../../src/utils/wagmiConfig';

markdown-examples.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)