Merge pull request #246 from vordgi/rd-245

rd-245 add package links
vordgi · Oct 1, 2024 · 12122a5 · 12122a5
2 parents a070fe5 + 4d92679
commit 12122a5
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,5 @@
----
-title: Introduction
-description: Robindoc is a framework for automatically creating documentation websites based on markdown files, built on React.js Server Components
----
+[robin.title]: # "Introduction"
+[robin.description]: # "Robindoc is a framework for automatically creating documentation websites based on markdown files, built on React.js Server Components"
 
 # Robindoc
 
@@ -11,6 +9,8 @@ Read the documentation in a convenient interface at [robindoc.com/docs](https://
 
 <!---/robin-->
 
+<!---robin PackageLinks /-->
+
 Robindoc is a framework for automatically creating documentation websites based on markdown files, built on React.js Server Components.
 
 ```tsx

diff --git a/packages/robindoc/package.json b/packages/robindoc/package.json
@@ -1,6 +1,6 @@
 {
   "name": "robindoc",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "main": "./lib/index.js",
   "scripts": {

diff --git a/site/src/app/docs/[[...path]]/page.tsx b/site/src/app/docs/[[...path]]/page.tsx
@@ -1,7 +1,9 @@
-import { Note } from "../../../components/ui/note";
-import { Page, Sidebar, getMeta, getPages, getPageData } from "./robindoc";
-import { KeylinkToNavigation } from "robindoc";
 import Link from "next/link";
+import { KeylinkToNavigation } from "robindoc";
+
+import { Page, Sidebar, getMeta, getPages, getPageData } from "./robindoc";
+import { Note } from "../../../components/ui/note";
+import { PackageLinks } from "../../../components/ui/package-links";
 
 export default async function Docs({params}: {params: {path?: string[]}}) {
     const path = '/docs/' + (params.path?.join('/') || '');
@@ -15,6 +17,7 @@ export default async function Docs({params}: {params: {path?: string[]}}) {
                 link={Link}
                 components={{
                     Note,
+                    PackageLinks,
                 }}
                 config={{
                     publicDirs: ['public']

diff --git a/site/src/app/docs/[[...path]]/robindoc.ts b/site/src/app/docs/[[...path]]/robindoc.ts
@@ -2,8 +2,8 @@ import { initializeRobindoc } from "robindoc";
 
 export const { Page, Sidebar, getPages, getMeta, getPageContent, getPageData } = initializeRobindoc(async () => ({
     configuration: {
-        // sourceRoot: '../docs',
-        sourceRoot: 'https://github.com/vordgi/robindoc/tree/main/docs',
+        // sourceRoot: 'https://github.com/vordgi/robindoc/tree/main/docs',
+        sourceRoot: '../docs',
         basePath: '/docs',
         gitToken: process.env.GIT_TOKEN,
     },
@@ -13,7 +13,8 @@ export const { Page, Sidebar, getPages, getMeta, getPageContent, getPageData } =
             type: 'heading',
             href: '/',
             configuration: {
-                sourceRoot: 'https://github.com/vordgi/robindoc/tree/main/README.md',
+                // sourceRoot: 'https://github.com/vordgi/robindoc/tree/main/README.md',
+                sourceRoot: '..',
             }
         },
         "auto-spreaded"

diff --git a/site/src/components/ui/package-links/index.tsx b/site/src/components/ui/package-links/index.tsx
@@ -0,0 +1,30 @@
+import React from 'react';
+
+import './package-links.scss';
+
+export const PackageLinks = () => {
+    return (
+        <div className="package-links">
+            <a
+                href="https://npmjs.com/package/robindoc"
+                className="package-links-link package-links-link-npm"
+                target="_blank"
+                rel="noopener noreferrer"
+            >
+                <span className="package-links-link-inner">
+                    NPM
+                </span>
+            </a>
+            <a
+                href="https://github.com/vordgi/robindoc"
+                className="package-links-link package-links-link-github"
+                target="_blank"
+                rel="noopener noreferrer"
+            >
+                <span className="package-links-link-inner">
+                    GitHub
+                </span>
+            </a>
+        </div>
+    )
+}
diff --git a/site/src/components/ui/package-links/package-links.scss b/site/src/components/ui/package-links/package-links.scss
@@ -0,0 +1,29 @@
+.package-links {
+  display: grid;
+  grid-auto-flow: column;
+  justify-content: flex-start;
+  gap: 12px;
+}
+
+.package-links-link {
+  font-weight: 500;
+  border-radius: 6px;
+  text-decoration: none;
+  color: inherit;
+  padding: 2px;
+}
+
+.package-links-link-inner {
+  display: block;
+  padding: 4px 12px;
+  background-color: var(--body);
+  border-radius: 4px;
+}
+
+.package-links-link-npm {
+  background: linear-gradient(90deg, #f97316, #ec4899);
+}
+
+.package-links-link-github {
+  background: var(--neutral800);
+}