https://github.com/timvir/timvir
[timˈvir] n. book
https://github.com/timvir/timvir
documentation react styleguide
Last synced: 3 months ago
JSON representation
[timˈvir] n. book
- Host: GitHub
- URL: https://github.com/timvir/timvir
- Owner: timvir
- License: mit
- Created: 2020-03-06T07:58:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-23T18:06:33.000Z (5 months ago)
- Last Synced: 2026-01-24T07:21:35.385Z (5 months ago)
- Topics: documentation, react, styleguide
- Language: TypeScript
- Homepage: https://timvir.vercel.app
- Size: 33.3 MB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
## What is Timvir?
Timvir is a project documentation tool, currently optimized for React + Next.js projects (though nothing ties it inherently to Next.js). In its core, Timvir is a set of React
**components** and **conventions** which aim to make writing documentation easier.
Timvir grew out of our realization that we want the documentation to be part of the product (website, web app), not a separate artefact.
As such, Timvir is meant to be integrated into, and deployed as part of your product. For example, in a Next.js app it means putting the
documentation into `pages/docs/**/*.mdx`, and making it available under `https://example.com/docs`.
The `timvir/blocks` package provides standard components for documenting colors, typography, react components etc. This set of components
will be expanded in the future to cover the needs when documenting a project and its design system.
A second part of Timvir is a set of **conventions** how to write and document React components. It is not necessary to follow these conventions
when using Timvir, though they are used internally in the Timvir codebase and certain tooling around Timvir relies heavily on those.
These conventions are a living standard, subject to change as we discover ways how to refine them.
## Stage
The current focus is on:
- Integrate timvir into a few projects to find out whether the conventions makes sense.
- Improve the rough edges in the commandline tool, make common operations easy to execute.
- Expand the set of components based on the users needs when writing documentation pages.
## Prior art
- **[Catalog](https://catalog.style)**: Based on plain Markdown, with custom blocks (called specimen).
- **[Docup](https://docup.now.sh/)**: Similar to Catalog, based on Markdown, limited set of custom blocks.
- **[Docz](https://www.docz.site/)**: Uses Gatsby + MDX, limited set of custom blocks.