Skip to content

Commit 1d5772d

Browse files
author
MRBadri
committed
refactor: update project structure and configuration; rename organization scope to @IconSync, add examples, and remove deprecated packages
1 parent 2005eb7 commit 1d5772d

File tree

136 files changed

+2894
-3155
lines changed

Some content is hidden

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

136 files changed

+2894
-3155
lines changed

‎.changeset/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
"linked": [],
88
"access": "public",
99
"updateInternalDependencies": "patch",
10-
"ignore": ["@acme/docs"]
10+
"ignore": ["@iconsync/docs"]
1111
}

‎README.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ This Turborepo includes the following:
1616

1717
### Apps and Packages
1818

19-
- `@acme/docs`: A placeholder documentation site powered by [Next.js](https://nextjs.org/)
20-
- `@acme/core`: core React components
21-
- `@acme/utils`: shared React utilities
22-
- `@acme/tsconfig`: shared `tsconfig.json`s used throughout the monorepo
23-
- `@acme/eslint-config`: ESLint preset
19+
- `@iconsync/docs`: Documentation site powered by [Nextra](https://nextra.site/) and [Next.js](https://nextjs.org/)
20+
- `@iconsync/docs`: A placeholder documentation site powered by [Next.js](https://nextjs.org/)
21+
- `@iconsync/core`: core React components
22+
- `@iconsync/utils`: shared React utilities
23+
- `@iconsync/tsconfig`: shared `tsconfig.json`s used throughout the monorepo
24+
- `@iconsync/eslint-config`: ESLint preset
2425

2526
Each package and app is 100% [TypeScript](https://www.typescriptlang.org/).
2627

@@ -42,7 +43,7 @@ This Turborepo has some additional tools already setup for you:
4243

4344
### Changing the npm organization scope
4445

45-
The npm organization scope for this design system starter is `@acme`. To change this, it's a bit manual at the moment, but you'll need to do the following:
46+
The npm organization scope for this design system starter is `@iconsync`. To change this, it's a bit manual at the moment, but you'll need to do the following:
4647

4748
- Rename folders in `packages/*` to replace `acme` with your desired scope
4849
- Search and replace `acme` with your desired scope

‎apps/docs/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Figmicon Documentation
2+
3+
This is the documentation site for Figmicon, built with [Nextra](https://nextra.site/) and [Next.js](https://nextjs.org/).
4+
5+
## Development
6+
7+
To start the development server:
8+
9+
```bash
10+
pnpm dev
11+
```
12+
13+
This will start the Next.js development server on [http://localhost:3000](http://localhost:3000).
14+
15+
## Building
16+
17+
To build the documentation site:
18+
19+
```bash
20+
pnpm build
21+
```
22+
23+
## Structure
24+
25+
- `pages/`: Documentation content in MDX format
26+
- `theme.config.jsx`: Nextra theme configuration
27+
- `next.config.js`: Next.js configuration with Nextra setup
28+
29+
## Adding New Documentation
30+
31+
1. Create a new `.mdx` file in the `pages/` directory
32+
2. Add the page to the appropriate `_meta.json` file to include it in the navigation
33+
34+
## Features
35+
36+
- **MDX Support**: Write documentation in Markdown with JSX components
37+
- **Code Highlighting**: Syntax highlighting for code blocks
38+
- **Search**: Full-text search functionality
39+
- **Dark Mode**: Built-in dark mode support
40+
- **Navigation**: Automatically generated sidebar navigation

‎apps/docs/next.config.js‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1-
module.exports = {
1+
const withNextra = require('nextra')({
2+
theme: 'nextra-theme-docs',
3+
themeConfig: './theme.config.jsx'
4+
})
5+
6+
module.exports = withNextra({
27
reactStrictMode: true,
3-
};
8+
transpilePackages: ['@iconsync/core'],
9+
eslint: {
10+
// Warning: This allows production builds to successfully complete even if
11+
// your project has ESLint errors.
12+
ignoreDuringBuilds: true,
13+
},
14+
})

‎apps/docs/package.json‎

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,26 @@
11
{
2-
"name": "@acme/docs",
3-
"version": "0.0.0",
2+
"name": "docs",
3+
"version": "0.1.0",
44
"private": true,
55
"scripts": {
6+
"dev": "next dev",
67
"build": "next build",
7-
"start": "next start ",
8-
"dev": "next dev -p 3002",
8+
"start": "next start",
99
"lint": "next lint",
10-
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf .next",
11-
"icon:fetch": "figmicon fetch --out tmp/icons",
12-
"icon:cache:stats": "figmicon cache:stats",
13-
"icon:cache:clear": "figmicon cache:clear",
14-
"icon:generate": "figmicon generator"
10+
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf .next"
1511
},
1612
"dependencies": {
17-
"@acme/utils": "workspace:*",
18-
"@figmicon/core": "workspace:*",
19-
"@figmicon/icons": "workspace:*",
20-
"next": "^14.1.1",
13+
"next": "^14.1.0",
14+
"nextra": "^2.13.2",
15+
"nextra-theme-docs": "^2.13.2",
2116
"react": "^18.2.0",
2217
"react-dom": "^18.2.0"
2318
},
2419
"devDependencies": {
25-
"@acme/eslint-config": "workspace:*",
26-
"@acme/tsconfig": "workspace:*",
27-
"@next/eslint-plugin-next": "^14.1.1",
28-
"@svgr/cli": "^8.1.0",
29-
"@types/node": "^20.11.24",
30-
"@types/react": "^18.2.61",
31-
"@types/react-dom": "^18.2.19",
32-
"typescript": "5.5.4"
20+
"@iconsync/tsconfig": "workspace:*",
21+
"@types/node": "^20.11.0",
22+
"@types/react": "^18.2.0",
23+
"@types/react-dom": "^18.2.0",
24+
"typescript": "^5.3.0"
3325
}
3426
}

‎apps/docs/pages/_app.tsx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import type { AppProps } from 'next/app'
2+
import { Inter } from 'next/font/google'
3+
import '../styles/globals.css'
4+
5+
const inter = Inter({ subsets: ['latin'] })
6+
7+
export default function App({ Component, pageProps }: AppProps) {
8+
return (
9+
<main className={inter.className}>
10+
<Component {...pageProps} />
11+
</main>
12+
)
13+
}

‎apps/docs/pages/_meta.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"index": "Introduction",
3+
"getting-started": "Getting Started",
4+
"components": "Components",
5+
"icons": "Icons",
6+
"theming": "Theming"
7+
}

‎apps/docs/pages/components.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Components
2+
3+
Figmicon provides a set of reusable UI components that you can use to build your applications.
4+
5+
## Available Components
6+
7+
- [Button](/components/button)
8+
- [Card](/components/card)
9+
- [Text](/components/text)
10+
- [Input](/components/input)
11+
- [Icon](/components/icon)
12+
13+
Each component is designed to be flexible and customizable to fit your needs.

‎apps/docs/pages/getting-started/_meta.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"installation": "Installation",
3+
"usage": "Usage"
4+
}

‎apps/docs/pages/getting-started/installation.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Installation
2+
3+
## Using package manager
4+
5+
```bash
6+
# npm
7+
npm install @iconsync/core
8+
9+
# yarn
10+
yarn add @iconsync/core
11+
12+
# pnpm
13+
pnpm install @iconsync/core
14+
```
15+
16+
## Basic Usage
17+
18+
```jsx
19+
import { Button } from '@iconsync/core';
20+
21+
export default function App() {
22+
return (
23+
<Button variant="primary">
24+
Click me
25+
</Button>
26+
);
27+
}
28+
```

0 commit comments

Comments
 (0)