feat: add docs

themesberg · Jul 12, 2023 · 9d52dac · 9d52dac
1 parent aaf53f2
commit 9d52dac
Show file tree

Hide file tree

Showing 10 changed files with 333 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -65,9 +65,9 @@ To avoid any complaints from the editor, add `node16` or `nodenext` to `moduleRe
 
 ```json
 {
-  //...
+
   "compilerOptions": {
-    // ...
+
     "moduleResolution": "nodenext"
   }
 }

diff --git a/package.json b/package.json
@@ -50,6 +50,7 @@
     "eslint-plugin-svelte": "^2.31.0",
     "flowbite": "^1.6.6",
     "flowbite-svelte": "^0.38.5",
+    "mdsvex": "^0.11.0",
     "postcss": "^8.4.24",
     "postcss-load-config": "^4.0.1",
     "prettier": "^2.8.8",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/app.postcss b/src/app.postcss
@@ -2,3 +2,31 @@
 @tailwind base;
 @tailwind components;
 @tailwind utilities;
+
+h1, h2, h3, p, ul, li, table{
+  @apply dark:text-white;
+}
+
+h1 {
+  @apply text-3xl my-8;
+}
+
+h2 {
+  @apply text-2xl my-6;
+}
+
+h3 {
+  @apply text-xl my-5;
+}
+
+p {
+  @apply text-lg my-3;
+}
+
+a {
+  @apply text-blue-900 dark:text-blue-400 hover:underline;
+}
+
+pre {
+  @apply bg-gray-100 text-gray-900 dark:text-gray-900 m-4 p-4;
+}
diff --git a/src/routes/+layout.svelte b/src/routes/+layout.svelte
@@ -7,6 +7,10 @@
   import NavLi from 'flowbite-svelte/NavLi.svelte';
   import NavUl from 'flowbite-svelte/NavUl.svelte';
   import NavHamburger from 'flowbite-svelte/NavHamburger.svelte';
+  import Footer from 'flowbite-svelte/Footer.svelte'
+  import FooterCopyright from 'flowbite-svelte/FooterCopyright.svelte'
+  import FooterLinkGroup from 'flowbite-svelte/FooterLinkGroup.svelte'
+  import FooterLink from 'flowbite-svelte/FooterLink.svelte'
   import { MetaTags } from 'svelte-meta-tags';
 
   $: activeUrl = $page.url.pathname;
@@ -43,10 +47,24 @@
     <NavLi href="/" active={activeUrl === '/'}>Home</NavLi>
     <NavLi href="/outline" active={activeUrl === '/outline'}>Outline</NavLi>
     <NavLi href="/solid" active={activeUrl === '/solid'}>Solid</NavLi>
-    <NavLi href="https://shinokada.github.io/flowbite-svelte-icons/">Docs</NavLi>
+    <NavLi href="/docs">Docs</NavLi>
     <NavLi href="https://github.com/themesberg/flowbite-svelte-icons">GitHub</NavLi>
     <NavLi href="https://svelte-svg-icons.vercel.app/">Icon sets</NavLi>
   </NavUl>
   <DarkMode />
 </Navbar>
-<slot />
+<div class="mx-16 mb-16">
+  <slot />
+</div>
+
+
+<Footer class="dark:bg-gray-900">
+  <FooterCopyright href="/" by="Flowbite Svelte Icons" year={2023} />
+  <FooterLinkGroup ulClass="flex flex-wrap items-center mt-3 text-sm text-gray-500 dark:text-gray-400 sm:mt-0">
+    <FooterLink href="/outline">Outline</FooterLink>
+    <FooterLink href="/solid">Solid</FooterLink>
+    <FooterLink href="/docs">Docs</FooterLink>
+    <FooterLink href="https://github.com/shinokada/flowbite-svelte-icons/blob/main/LICENSE">Licensing</FooterLink>
+    <FooterLink href="https://github.com/themesberg/flowbite-svelte-icons">GitHub</FooterLink>
+  </FooterLinkGroup>
+</Footer>
diff --git a/src/routes/+page.svelte b/src/routes/+page.svelte
@@ -22,7 +22,7 @@
   $: filteredEntries = Object.entries(Icons).filter(([name, component]) => {
     return name.toLowerCase().indexOf(searchTerm.toLowerCase()) !== -1;
   });
-  let divClass = 'mx-16';
+  let divClass = '';
 </script>
 
 <TableSearch
-Original file line number
+Diff line change
@@ Expand Up @@
     ```json
     {
-      //...
       "compilerOptions": {
-        // ...
         "moduleResolution": "nodenext"
       }
     }
@@ Expand Down @@