search

tinalabs / tinacms-doc-toolkit

A toolkit for creating isolated documentation sites for Tina plugins, utilities, and packages.
https://tinalabs.github.io/tinacms-doc-toolkit/
0 stars 0 forks source link

readme

Welcome to the react tinacms documentation toolkit

Getting started

  1. Create a new docs site: npx create-next-app --example https://github.com/tinalabs/tinacms-doc-toolkit/tree/master/packages/example-site-next docs

  2. Then navigate to the docs site: cd docs

  3. And start the dev server and follow the on-screen instructions: npm run dev

You can see further instructions for getting started and using the toolkit in the documentation.

Note

This toolkit comes pre-configured to deploy to Github pages, with a Github actions workflow stored in the .github folder.

If you create a new Github repository with this site, it will automatically deploy to Github pages.

Setting up from scratch

Please see SETUP.md for instructions on how to get up a nextjs site from scratch using the plugin