Skip to content

Commit 31a072c

Browse files
anoopkarnikanoopkarnik
committed
add docusaurus docs
1 parent 5b3851a commit 31a072c

Some content is hidden

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

69 files changed

+10387
-4119
lines changed

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ Clone the Notion Templates for the below systems.
3434

3535
## Installation Guide
3636

37+
### Without Docker
38+
39+
### With Docker
3740
1) npm i
3841
2) npm run db:generate
3942
3) npm run dev to run all the apps

‎apps/dashboard-app/.source/index.d.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import type { GetOutput } from "fumadocs-mdx/config"
2+
export declare const docs: GetOutput<typeof import("../source.config.ts").docs>
3+
export declare const meta: GetOutput<typeof import("../source.config.ts").meta>

‎apps/dashboard-app/.source/index.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { toRuntime, toRuntimeAsync } from "fumadocs-mdx"
2+
export const docs = [];
3+
export const meta = [];

‎apps/dashboard-app/.source/source.config.mjs

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// source.config.ts
2+
import { defineDocs, defineConfig } from "fumadocs-mdx/config";
3+
var { docs, meta } = defineDocs({
4+
dir: "content/docs"
5+
});
6+
var source_config_default = defineConfig();
7+
export {
8+
source_config_default as default,
9+
docs,
10+
meta
11+
};

‎apps/dashboard-app/app/layout.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,12 @@ import { ConnectionsProvider } from "../providers/connections-provider";
77
import useConnection from "../hooks/useConnection";
88
import { Toaster } from "../components/Toaster";
99

10-
11-
1210
const font = Roboto_Mono({
1311
subsets: ["latin"]
1412
})
1513

1614
export const metadata: Metadata = {
17-
title: "Personal Automation System",
15+
title: "Code Automation Systems",
1816
description: "Personal Automation System for all your personal and professional automation needs",
1917
};
2018

@@ -29,7 +27,7 @@ export default function RootLayout({
2927
<SessionProviders>
3028
<ThemeProvider attribute="class" defaultTheme="dark" enableSystem disableTransitionOnChange>
3129
<ConnectionsProvider>
32-
<main>{children}</main>
30+
<main>{children}</main>
3331
<Toaster/>
3432
</ConnectionsProvider>
3533
</ThemeProvider>

‎apps/dashboard-app/components/LeftSidebarClient.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const LeftSidebarClient = () => {
1515
return (
1616
<>
1717
<LeftSidebar
18-
appName="Personal Automation System"
18+
appName="Code Automation System"
1919
appIcon="https://raw.githubusercontent.com/anoopkarnik/personal-apps/main/apps/dashboard-app/public/apps.png"
2020
sidebarStartItems={sidebarStartItems}
2121
sidebarEndItems={sidebarEndItems}

‎apps/dashboard-app/next.config.mjs

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
import nextra from "nextra";
2-
import { hostname } from "os";
1+
import { createMDX } from 'fumadocs-mdx/next';
2+
3+
const withMDX = createMDX();
4+
35

46
/** @type {import('next').NextConfig} */
57
const nextConfig = {
@@ -17,12 +19,11 @@ const nextConfig = {
1719
}
1820
};
1921

20-
const withNextraDocs = nextra({
21-
theme: 'nextra-theme-docs',
22-
themeConfig: './theme-docs.config.jsx',
23-
basePath: '/docs'
24-
});
22+
// const withNextraDocs = nextra({
23+
// theme: 'nextra-theme-docs',
24+
// themeConfig: './theme-docs.config.jsx'
25+
// });
2526

26-
const combinedConfig = withNextraDocs(nextConfig);
27+
const combinedConfig = withMDX(nextConfig);
2728

2829
export default combinedConfig;

‎apps/dashboard-app/package.json

+1-3
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
"@repo/resend-email": "*",
2626
"@repo/ui": "*",
2727
"@repo/winston-logger": "*",
28+
"@types/mdx": "^2.0.13",
2829
"@uiw/react-codemirror": "^4.23.0",
2930
"bcryptjs": "^2.4.3",
3031
"class-variance-authority": "^0.7.0",
@@ -38,9 +39,6 @@
3839
"next": "^14.2.15",
3940
"next-auth": "^5.0.0-beta.22",
4041
"next-themes": "^0.3.0",
41-
"nextra": "^2.13.4",
42-
"nextra-theme-blog": "^2.13.4",
43-
"nextra-theme-docs": "^2.13.4",
4442
"notion-client": "^6.16.0",
4543
"react": "^18",
4644
"react-beautiful-dnd": "^13.1.1",

‎apps/dashboard-app/pages/docs.mdx

-4
This file was deleted.

‎apps/dashboard-app/pages/docs/_meta.json

-10
This file was deleted.

‎apps/dashboard-app/public/SSSS.png

42.7 KB
Loading

‎apps/dashboard-app/public/apps.png

-25.8 KB
Loading

‎apps/dashboard-app/source.config.ts

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineDocs, defineConfig } from 'fumadocs-mdx/config';
2+
3+
export const { docs, meta } = defineDocs({
4+
dir: 'content/docs',
5+
});
6+
7+
export default defineConfig();

‎apps/dashboard-app/tailwind.config.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { sub } from "date-fns";
21
import type { Config } from "tailwindcss";
32
import tailwindcssAnimate from "tailwindcss-animate";
43

@@ -11,7 +10,7 @@ const config = {
1110
"./src/**/*.{ts,tsx}",
1211
"../../packages/ui/src/**/*.{ts,tsx,js,jsx,mdx}",
1312
'./.storybook/**/*.{js,ts,jsx,tsx,mdx}', // Include Storybook stories
14-
'./stories/**/*.{js,ts,jsx,tsx,mdx}',
13+
'./stories/**/*.{js,ts,jsx,tsx,mdx}'
1514
],
1615
prefix: "",
1716
theme: {

‎apps/dashboard-app/theme-docs.config.jsx

-19
This file was deleted.

‎apps/dashboard-app/tsconfig.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@
1414
"**/*.ts",
1515
"**/*.tsx",
1616
".next/types/**/*.ts",
17-
"middleware.ts"
18-
, "pages/_app.ts" ],
17+
"middleware.ts" ],
1918
"exclude": [
2019
"node_modules"
2120
]

‎apps/docs/.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎apps/docs/README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎apps/docs/blog/2019-05-28-first-blog-post.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
slug: first-blog-post
3+
title: First Blog Post
4+
authors: [slorber, yangshun]
5+
tags: [hola, docusaurus]
6+
---
7+
8+
Lorem ipsum dolor sit amet...
9+
10+
<!-- truncate -->
11+
12+
...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

‎apps/docs/blog/2019-05-29-long-blog-post.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
slug: long-blog-post
3+
title: Long Blog Post
4+
authors: yangshun
5+
tags: [hello, docusaurus]
6+
---
7+
8+
This is the summary of a very long blog post,
9+
10+
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
11+
12+
<!-- truncate -->
13+
14+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15+
16+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17+
18+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19+
20+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21+
22+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23+
24+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25+
26+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27+
28+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29+
30+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31+
32+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33+
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35+
36+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37+
38+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39+
40+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43+
44+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

‎apps/docs/blog/2021-08-01-mdx-blog-post.mdx

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
slug: mdx-blog-post
3+
title: MDX Blog Post
4+
authors: [slorber]
5+
tags: [docusaurus]
6+
---
7+
8+
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
9+
10+
:::tip
11+
12+
Use the power of React to create interactive blog posts.
13+
14+
:::
15+
16+
{/* truncate */}
17+
18+
For example, use JSX to create an interactive button:
19+
20+
```js
21+
<button onClick={() => alert('button clicked!')}>Click me!</button>
22+
```
23+
24+
<button onClick={() => alert('button clicked!')}>Click me!</button>

‎apps/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg

93.9 KB
Loading

‎apps/docs/blog/2021-08-26-welcome/index.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
slug: welcome
3+
title: Welcome
4+
authors: [slorber, yangshun]
5+
tags: [facebook, hello, docusaurus]
6+
---
7+
8+
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
9+
10+
Here are a few tips you might find useful.
11+
12+
<!-- truncate -->
13+
14+
Simply add Markdown files (or folders) to the `blog` directory.
15+
16+
Regular blog authors can be added to `authors.yml`.
17+
18+
The blog post date can be extracted from filenames, such as:
19+
20+
- `2019-05-30-welcome.md`
21+
- `2019-05-30-welcome/index.md`
22+
23+
A blog post folder can be convenient to co-locate blog post images:
24+
25+
![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
26+
27+
The blog supports tags as well!
28+
29+
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

‎apps/docs/blog/authors.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
yangshun:
2+
name: Yangshun Tay
3+
title: Front End Engineer @ Facebook
4+
url: https://github.com/yangshun
5+
image_url: https://github.com/yangshun.png
6+
page: true
7+
socials:
8+
x: yangshunz
9+
github: yangshun
10+
11+
slorber:
12+
name: Sébastien Lorber
13+
title: Docusaurus maintainer
14+
url: https://sebastienlorber.com
15+
image_url: https://github.com/slorber.png
16+
page:
17+
# customize the url of the author page at /blog/authors/<permalink>
18+
permalink: '/all-sebastien-lorber-articles'
19+
socials:
20+
x: sebastienlorber
21+
linkedin: sebastienlorber
22+
github: slorber
23+
newsletter: https://thisweekinreact.com

0 commit comments

Comments
 (0)