Skip to content

Commit

Permalink
update package.json and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rajaniraiyn committed Jul 6, 2023
1 parent 2dbe015 commit 44e9a18
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 36 deletions.
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,3 @@
# Nextra Docs Template
# CDS Docs

This is a template for creating documentation with [Nextra](https://nextra.site).

[**Live Demo →**](https://nextra-docs-template.vercel.app)

[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)

## Quick Start

Click the button to clone this repository and deploy it on Vercel:

[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgit.luolix.top%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)

## Local Development

First, run `pnpm i` to install the dependencies.

Then, run `pnpm dev` to start the development server and visit localhost:3000.

## License

This project is licensed under the MIT License.
Documentation Site for Continuum Design System (CDS) by Verve.
41 changes: 27 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,28 +1,41 @@
{
"name": "docs",
"version": "0.0.1",
"description": "Documentation Site for Continuum Design System",
"description": "Documentation Site for Continuum Design System (CDS) by Verve",
"license": "MIT",
"private": true,
"repository": {
"type": "git",
"url": "git+https://github.com/cds-design/docs.git"
},
"bugs": {
"url": "https://github.com/cds-design/docs/issues"
},
"homepage": "https://github.com/cds-design/docs#readme",
"type": "module",
"scripts": {
"build": "pnpm gen && next build",
"dev": "pnpm gen && next dev",
"gen:vars": "generate variables ./pages/reference/variables.mdx",
"gen:components": "generate components ./pages/components",
"gen": "pnpm gen:vars && pnpm gen:components",
"build": "pnpm gen && next build",
"gen:components": "generate components ./pages/components",
"gen:vars": "generate variables ./pages/reference/variables.mdx",
"start": "next start"
},
"repository": {
"type": "git",
"url": "git+https://github.com/Continuum-Design-System/docs.git"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/Continuum-Design-System/docs/issues"
},
"homepage": "https://github.com/Continuum-Design-System/docs#readme",
"maintainers": [
{
"name": "Rajaniraiyn R",
"email": "rajaniraiyn@gmail.com",
"url": "https://rajaniraiyn.github.io"
},
{
"name": "Tejaswini T",
"email": "teejaswan12@gmail.com",
"url": "https://teejaswan.github.io"
}
],
"dependencies": {
"ahooks": "^3.7.8",
"cds-design": "workspace:*",
"cds-design": "*",
"next": "^13.4.8",
"nextra": "latest",
"nextra-theme-docs": "latest",
Expand Down

0 comments on commit 44e9a18

Please sign in to comment.