Merge pull request #6 from cslant/feat/setup-github-project-docs

Feat/setup GitHub project docs

docusaurus.config.ts

@@ -1,7 +1,7 @@
 import type { Config } from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
 import Navbar from "./src/configs/navbar";
-import { LaravelLikePackageConfig, TelegramGitNotifierPackageConfig } from "./pluginConfigs";
+import { GithubProjectPHPConfig, LaravelLikePackageConfig, TelegramGitNotifierPackageConfig } from './pluginConfigs';
 import { RepoDocsStatic } from "./src/configs/staticDirectories";
 import PrismConfig from "./src/configs/prism";
 import AlgoliaConfig from "./src/configs/algolia";
@@ -90,6 +90,10 @@ const config: Config = {
       '@docusaurus/plugin-content-docs',
       LaravelLikePackageConfig,
     ],
+    [
+      '@docusaurus/plugin-content-docs',
+      GithubProjectPHPConfig,
+    ],
     [
       '@docusaurus/plugin-google-gtag',
       {

package.json

@@ -16,31 +16,31 @@
   },
   "dependencies": {
     "@algolia/client-search": "^4.24.0",
-    "@docusaurus/core": "^3.6.3",
-    "@docusaurus/plugin-client-redirects": "^3.6.3",
-    "@docusaurus/plugin-google-gtag": "^3.6.3",
-    "@docusaurus/plugin-sitemap": "^3.6.3",
-    "@docusaurus/preset-classic": "^3.6.3",
-    "@docusaurus/theme-live-codeblock": "^3.6.3",
-    "@docusaurus/theme-mermaid": "^3.6.3",
+    "@docusaurus/core": "^3.7.0",
+    "@docusaurus/plugin-client-redirects": "^3.7.0",
+    "@docusaurus/plugin-google-gtag": "^3.7.0",
+    "@docusaurus/plugin-sitemap": "^3.7.0",
+    "@docusaurus/preset-classic": "^3.7.0",
+    "@docusaurus/theme-live-codeblock": "^3.7.0",
+    "@docusaurus/theme-mermaid": "^3.7.0",
     "@mdx-js/react": "^3.1.0",
     "@types/react": "^19.0.2",
     "clsx": "^2.1.1",
     "docusaurus-plugin-sass": "^0.2.6",
-    "dotenv": "^16.4.5",
-    "prism-react-renderer": "^2.4.0",
+    "dotenv": "^16.4.7",
+    "prism-react-renderer": "^2.4.1",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
     "react-loadable": "^5.5.0",
-    "sass": "^1.79.4",
-    "search-insights": "^2.17.2",
+    "sass": "^1.85.0",
+    "search-insights": "^2.17.3",
     "webpack": "^5.97.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.6.3",
-    "@docusaurus/tsconfig": "3.6.3",
-    "@docusaurus/types": "3.6.3",
-    "typescript": "~5.6.3"
+    "@docusaurus/module-type-aliases": "^3.7.0",
+    "@docusaurus/tsconfig": "^3.7.0",
+    "@docusaurus/types": "^3.7.0",
+    "typescript": "~5.7.3"
   },
   "browserslist": {
     "production": [

pluginConfigs.ts

@@ -17,3 +17,13 @@ export const LaravelLikePackageConfig = {
   showLastUpdateAuthor: true,
   showLastUpdateTime: true,
 };
+
+export const GithubProjectPHPConfig = {
+  id: 'github-project-php',
+  path: './repos/github-project-php-docs',
+  routeBasePath: 'github-project-php',
+  sidebarPath: require.resolve('./repos/github-project-php-docs/sidebar.ts'),
+  editUrl: ({ docPath }) => `https://github.com/cslant/github-project-php-docs/edit/main/${docPath}`,
+  showLastUpdateAuthor: true,
+  showLastUpdateTime: true,
+};

src/components/HomepageFeatures/index.tsx

@@ -1,6 +1,6 @@
 import Heading from '@theme/Heading';
 import styles from './styles.module.css';
-import React from "react";
+import React, { JSX } from "react";
 
 type FeatureItem = {
   title: string;

src/configs/navbar.ts

@@ -27,13 +27,18 @@ const Navbar = {
       items: [
         {
           label: 'Telegram Git Notifier Package',
-          href: '/telegram-git-notifier/',
+          href: '/telegram-git-notifier',
           id: 'telegram-git-notifier',
         }, {
           label: 'Laravel Like Package',
-          href: '/laravel-like/',
+          href: '/laravel-like',
           id: 'laravel-like',
         },
+        {
+          label: 'Github Project PHP',
+          href: '/github-project-php',
+          id: 'github-project-php',
+        }
       ],
     },
     {

src/configs/staticDirectories.ts

@@ -1,4 +1,5 @@
 export const RepoDocsStatic = [
   'repos/telegram-git-notifier-docs/assets/public',
   'repos/laravel-like-docs/assets/public',
+  'repos/github-project-php-docs/assets/public',
 ];

src/pages/github-project-php/index.tsx

@@ -0,0 +1,12 @@
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { Fragment, JSX } from 'react';
+import GithubProjectPHPHome from '@site/repos/github-project-php-docs/homepage';
+
+export default function Home(): JSX.Element {
+  const {siteConfig} = useDocusaurusContext();
+  return (
+      <Fragment>
+        <GithubProjectPHPHome/>
+      </Fragment>
+  );
+}

src/pages/index.tsx

@@ -5,6 +5,7 @@ import Heading from '@theme/Heading';
 import CSlantLogoBanner from '@site/static/img/cslant-logo.svg';
 import styles from './home/index.module.css';
 import Head from '@docusaurus/core/lib/client/exports/Head';
+import { JSX } from 'react';
 
 function HomepageHeader() {
   return (

src/pages/laravel-like/index.tsx

@@ -1,5 +1,5 @@
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {Fragment} from "react";
+import {Fragment, JSX} from "react";
 import LaravelLikePackageHome from "@site/repos/laravel-like-docs/homepage";
 
 export default function Home(): JSX.Element {

src/pages/telegram-git-notifier/index.tsx

@@ -1,6 +1,6 @@
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import TelegramGitNotifierHome from "@site/repos/telegram-git-notifier-docs/homepage";
-import {Fragment} from "react";
+import {Fragment, JSX} from "react";
 
 export default function Home(): JSX.Element {
   const {siteConfig} = useDocusaurusContext();