https://github.com/tinalabs/tinacms-doc-toolkit
A toolkit for creating isolated documentation sites for Tina plugins, utilities, and packages.
https://github.com/tinalabs/tinacms-doc-toolkit
Last synced: 26 days ago
JSON representation
A toolkit for creating isolated documentation sites for Tina plugins, utilities, and packages.
- Host: GitHub
- URL: https://github.com/tinalabs/tinacms-doc-toolkit
- Owner: tinalabs
- Created: 2020-10-13T13:28:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-21T14:54:05.000Z (over 5 years ago)
- Last Synced: 2025-03-01T04:44:30.175Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://tinalabs.github.io/tinacms-doc-toolkit/
- Size: 14.4 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
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](https://tinalabs.github.io/tinacms-doc-toolkit/).
> ## 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