/tina-docs-starter

Documentation Starter powered by MDX using Tina

Primary LanguageJavaScriptMIT LicenseMIT

Tina Documentation Starter

This Next.js starter is powered by TinaCMS and based upon Smooth Doc it allows you and your team to create beautiful docs powered by MDX.

Features

  • Light/dark mode toggle
  • Tina Headless CMS for authentication, content modeling, visual editing and team management.
  • MDX component support for easy to use resuable components
  • Vercel deployment to visually edit your site from the /admin route.
  • Local development workflow from the filesystem with a local GraqhQL server.

Requirements

Local Development

Install the project's dependencies:

yarn install

Run the project locally:

yarn dev

Building the Starter Locally (Using the hosted content API)

Replace the .env.example, with .env

NEXT_PUBLIC_TINA_CLIENT_ID=<get this from the project you create at app.tina.io>
TINA_TOKEN=<get this from the project you create at app.tina.io>
NEXT_PUBLIC_TINA_BRANCH=<Specify the branch with Tina configured>

Build the project:

yarn build

Local URLs

Getting Help

TinaCMS backend is in public beta, you might face issues, to provide feedback or get help with any challenges you may have:

Development tips

Visual Studio Code GraphQL extension

Install the GraphQL extension to benefit from type auto-completion.

LICENSE

Licensed under the MIT License.