|
| 1 | +--- |
| 2 | +title: NotCMS |
| 3 | +repo: qqpann/notcms |
| 4 | +homepage: https://notcms.com |
| 5 | +twitter: notcmsjs |
| 6 | +opensource: "Yes" |
| 7 | +typeofcms: "API Driven" |
| 8 | +supportedgenerators: |
| 9 | + - All |
| 10 | +description: NotCMS is a type-safe headless CMS that transforms Notion into a powerful content backend. Write content in Notion's familiar interface and publish instantly to any framework with full TypeScript support. |
| 11 | +images: |
| 12 | + - path: /img/cms/notcms.jpg |
| 13 | +--- |
| 14 | + |
| 15 | +## What is NotCMS? |
| 16 | + |
| 17 | +NotCMS makes it easy to create a CMS from Notion. It's a headless CMS that lets you use Notion's intuitive editor for content creation while providing developers with a type-safe TypeScript SDK for seamless integration with any frontend framework. |
| 18 | + |
| 19 | +## Quickstart |
| 20 | + |
| 21 | +Get started with NotCMS in minutes: |
| 22 | + |
| 23 | +```bash |
| 24 | +npm install notcms |
| 25 | +``` |
| 26 | + |
| 27 | +Then use the type-safe SDK in your code: |
| 28 | + |
| 29 | +```typescript |
| 30 | +import { Client } from "notcms"; |
| 31 | +import { schema } from "./notcms/schema"; // generated w/ npx notcms-kit pull |
| 32 | + |
| 33 | +const nc = new Client({ schema }) |
| 34 | +const [pages] = await nc.query.blog.list(); |
| 35 | +``` |
| 36 | + |
| 37 | +Visit [docs.notcms.com](https://docs.notcms.com) to explore starter templates. |
| 38 | + |
| 39 | +## Key Features |
| 40 | + |
| 41 | +### Developer experience |
| 42 | + |
| 43 | +- **Sync database schema**: Command-generated TypeScript types represent your Notion schema |
| 44 | +- **Simple list & get methods**: Clean, intuitive methods for fetching and querying content |
| 45 | + |
| 46 | +### Content Management Excellence |
| 47 | + |
| 48 | +- **Notion's powerful editor**: Leverage Notion's rich text editing, no need to learn another editor |
| 49 | +- **Content as Markdown**: Rich text is auto converted to markdown, an easy to handle format |
| 50 | +- **Images on CDN without expiration**: Fast, optimized image delivery out of the box |
| 51 | + |
| 52 | +## How It Works |
| 53 | + |
| 54 | +1. **Setup your Notion database** - Create content structures in Notion |
| 55 | +2. **Install NotCMS SDK** - Add the npm package to your project |
| 56 | +3. **Generate types** - Auto-generate TypeScript types from your schema |
| 57 | +4. **Query your content** - Use the type-safe API to fetch content |
| 58 | +5. **Deploy anywhere** - Ship to Vercel, Netlify, or any hosting platform |
| 59 | + |
| 60 | +## Why NotCMS? |
| 61 | + |
| 62 | +### Notion as Your CMS Backend |
| 63 | + |
| 64 | +Your team already knows Notion. Why force them to learn another CMS? NotCMS lets you leverage Notion's collaborative editing, rich content blocks, and database features while maintaining full control over your frontend. |
| 65 | + |
| 66 | +### Type Safety Throughout |
| 67 | + |
| 68 | +Never worry about runtime errors from CMS data. NotCMS generates complete TypeScript types from your Notion schema, ensuring type safety from content creation to production deployment. |
| 69 | + |
| 70 | +### No Vendor Lock-in |
| 71 | + |
| 72 | +Your content lives in Notion, not a proprietary database. Export it anytime, migrate if needed, and maintain complete ownership of your data. |
| 73 | + |
| 74 | +## Resources |
| 75 | + |
| 76 | +- [Website](https://notcms.com) |
| 77 | +- [Documentation](https://docs.notcms.com) |
| 78 | +- [Dashboard](https://dash.notcms.com) |
| 79 | +- [Templates](https://notcms.com/templates) |
| 80 | +- [GitHub](https://github.com/qqpann/notcms) |
0 commit comments