Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.52 KB

README.md

File metadata and controls

43 lines (29 loc) · 1.52 KB

TinaCMS Docs

The documentation site for TinaCMS, served at tina.io/docs. Built on the tina-docs starter.

Content is being migrated here from tina.io. Track progress in tinacms#7552.

Editing docs

Editors: open /admin on the deployed site and edit visually. Changes commit to a branch through TinaCloud.

Contributors: edit the MDX under content/docs/ (English) and open a PR. Chinese pages under content/docs-zh/ are generated by the translation workflow; do not hand-edit them.

Running locally

cp .env.example .env   # fill in the TinaCloud values from app.tina.io
pnpm install
pnpm dev               # site on :3000, CMS at /admin

Without TinaCloud credentials you can still validate the schema and content:

pnpm tinacms build --local --skip-cloud-checks

Layout

Path What lives there
content/docs/ English docs (MDX)
content/docs-zh/ Chinese docs (generated)
content/navigation-bar/ Sidebar tabs and groups
content/settings/ Site title, SEO defaults, redirects, theme
tina/collections/ TinaCMS schemas
tina/templates/markdown-embeds/ Embeddable components available in the body field
src/components/tina-markdown/ Renderers for standard markdown and embeds

For agent-facing guidance see AGENTS.md.

License

Apache 2.0