explainer/explainer.config.ts at main · LeadcodeDev/explainer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
import Blockquote from "@/components/content/blockquote/blockquote.astro";
import Callout from "@/components/content/callout.astro";
import CardGroup from "@/components/content/card-group/card-group.astro";
import Card from "@/components/content/card-group/card.astro";
import CodeGroup from "@/components/content/code-group/code-group.astro";
import CodePreview from "@/components/content/code-preview/code-preview.astro";
import ContentPreview from "@/components/content/code-preview/content-preview.astro";
import Preview from "@/components/content/code-preview/preview.astro";
import CodeBlock from "@/components/content/codeblock.astro";
import H2 from "@/components/content/heading/h2.astro";
import H3 from "@/components/content/heading/h3.astro";
import StepGroup from "@/components/content/step-group/step-group.astro";
import Step from "@/components/content/step-group/step.astro";
import Articles from "@/components/elements/articles.astro";
import { defineExplainerConfig } from "@/utils";

export default defineExplainerConfig({
  repository: "https://github.com/LeadcodeDev/explainer",
  projectName: "Explainer",
  seo: {
    title: "Explainer • Make your own documentation easily",
    description:
      "Quickly design your documentation and optimise it for search engine optimisation to showcase your products.",
    thumbnail: "/thumbnail.png",
  },
  socials: {
    media: {
      github: "https://github.com/LeadcodeDev/explainer",
      twitter: "https://twitter.com/LeadcodeDev",
      linkedin: "https://linkedin.com/in/leadcode-dev",
    },
  },
  blog: {
    defaults: {
      thumbnail: "/thumbnail.png",
    },
    authors: {
      leadcode_dev: {
        name: "LeadcodeDev",
        avatar: "https://avatars.githubusercontent.com/u/8946317?v=4",
        href: "https://github.com/LeadcodeDev",
      },
    },
  },
  navbar: [
    {
      label: "Documentations",
      icon: "lucide:book",
      children: [
        {
          label: "Getting Started",
          description: "Introduction to Explainer",
          icon: "lucide:info",
          href: "/docs/framework/getting-started/getting-started",
        },
        {
          label: "Installation",
          description: "Install and set up the project",
          icon: "lucide:play",
          href: "/docs/framework/getting-started/installation",
        },
        {
          label: "Project Structure",
          description: "Understand the folder layout",
          icon: "lucide:layout-panel-top",
          href: "/docs/framework/getting-started/project-structure",
        },
        {
          label: "Configuration",
          description: "Configure your site",
          icon: "lucide:settings-2",
          href: "/docs/framework/getting-started/configuration",
        },
        {
          label: "Deployment",
          description: "Deploy your documentation",
          icon: "lucide:cloud-lightning",
          href: "/docs/framework/getting-started/deploy",
        },
        {
          label: "Routing",
          description: "File-based routing system",
          icon: "lucide:signpost",
          href: "/docs/framework/foundamentals/routing",
        },
      ],
    },
    {
      label: "API",
      href: "/api",
    },
    {
      label: "Blog",
      href: "/blog",
    },
  ],
  content: {
    components: {
      "card-group": CardGroup,
      card: Card,
      codegroup: CodeGroup,
      "code-group": CodeGroup,
      pre: CodeBlock,
      callout: Callout,
      "step-group": StepGroup,
      step: Step,
      "code-preview": CodePreview,
      "content-preview": ContentPreview,
      preview: Preview,
      articles: Articles,
      blockquote: Blockquote,
      h2: H2,
      h3: H3,
    },
    icons: {
      markdown: "devicon:markdown",
      mdx: "devicon:markdown",
      html: "devicon:html5",
      css: "devicon:css3",
      javascript: "devicon:javascript",
      js: "devicon:javascript",
      typescript: "devicon:typescript",
      ts: "devicon:typescript",
      python: "devicon:python",
      py: "devicon:python",
      dart: "devicon:dart",
      rust: "catppuccin:rust",
      rs: "catppuccin:rust",
      npm: "devicon:npm",
      npx: "devicon:npm",
      yarn: "devicon:yarn",
      pnpm: "devicon:pnpm",
      cargo: "catppuccin:cargo",
      bun: "devicon:bun",
      vite: "devicon:vite",
      "tailwind.config.js": "devicon:tailwindcss",
      "tailwind.config.ts": "devicon:tailwindcss",
      react: "devicon:react",
      nextjs: "devicon:nextjs",
      svelte: "devicon:svelte",
      vue: "devicon:vuejs",
      go: "devicon:go",
      bash: "devicon:bash",
      sh: "devicon:bash",
      shell: "devicon:bash",
      sql: "devicon:azuresqldatabase",
      yaml: "devicon:yaml",
      yml: "devicon:yaml",
      json: "devicon:json",
      dockerfile: "devicon:docker",
      git: "devicon:git",
      github: "devicon:github",
      gitlab: "devicon:gitlab",
    },
  },
});