83544a9ea8
following up on https://discord.com/channels/859816885297741824/1162726738774720574/1211715924613275681 several things here: - `docs/api/.*json` were out-of-date — seems like fetch-api-source should run automatically? shouldn't `build-api` also override this directory? in particular, tldraw.api.json still had a ton of references to the old @tldraw/tldraw package - the main problem was that `generateApiContent` was failing silently. we were relying on Promises and this broke silently because we never handled exceptions. i got rid of the Promise as it was unnecessary and made the exceptions bubble up - two things were broken in the docs and those are fixed, so now the missing entries will resurface ### Change Type - [x] `documentation` — Changes to the documentation only[^2] --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com> |
||
|---|---|---|
| .. | ||
| api | ||
| app | ||
| components | ||
| content | ||
| public | ||
| scripts | ||
| styles | ||
| types | ||
| utils | ||
| .gitignore | ||
| .prettierignore | ||
| CHANGELOG.md | ||
| content.d.ts | ||
| LICENSE.md | ||
| next-env.d.ts | ||
| next.config.js | ||
| package.json | ||
| README.md | ||
| tsconfig.content.json | ||
| tsconfig.json | ||
| watcher.ts | ||
tldraw-docs
Welcome to the source for the tldraw docs site.
This site is a Next.js app that uses MDX for content. It contains human-written docs in the content folder as well as generated docs in the api folder.
We have several scripts that build these files into a SQLite database that is used to generate the site's pages.
To pull the most recent docs from the tldraw repo, create an .env file with a GitHub personal access token and the SHA of the commit or branch that you'd like to pull from.
ACCESS_TOKEN=your_github_access_token
SOURCE_SHA=main
The files are also provided in this repo.
Building the content
You can build the markdown and API content using the following scripts:
yarn refresh-everythingto reset the database, generate the markdown from the API docs, and populate the database with articles from both the regular content and the generated API contentyarn refresh-contentto generate just the regular content
Content
The docs has two types of content: regular content that is written by the team and auto-generated content that is created using tsdoc and API extractor.
The content folder contains all content in the form of MDX files. All articles belong to a "section" and a "category". The sections.json defines each section and any categories belonging to that section.
A section looks like this:
{
"id": "community",
"title": "Community",
"description": "Guides for contributing to tldraw's open source project.",
"categories": []
}
The content is organized into folders for each section. The gen folder contains auto-generated content.
Regular Content
The content folder contains all "regular" content in the form of MDX files.All articles belong to a "section" and a "category". The content is organized into folders for each "section".
An article's frontmatter looks like this:
---
title: User Interface
description: How to customize the tldraw user interface using overrides.
status: published
author: steveruizok
date: 3/22/2023
order: 8
keywords:
- ui
- interface
- tools
- shapes
- custom
- button
- toolbar
- styles
---
Title
The title is displayed in the article's header, in the page title, in the search bar, and in search results. It is used to find an article through the site's search feature.
Description
The description is hidden in the article's frontmatter, but is used to populate the article's meta description tag. It is also used to find an article through the site's search feature.
Hero
The hero is used for the article's social media image. It is not displayed in the article. It should refer to a page in the public/images folder.
Category
An article may declare its category in its frontmatter. Any article that does not declare a category will be placed into the "ucg" category for "uncategorized" articles.
Order
The order property defines the article's order in its category. Uncategorized articles are placed at the end of the list of categories sorted by its order. For a section without categories, the order keyword effectively defines the order that the article will appear in the section list.
Author
The author must refer to an author named in the content/authors.json file.
An author looks like this:
"steveruizok": {
"name": "Steve Ruiz",
"email": "steve@tldraw.com",
"twitter": "steveruizok",
"image": "steve_ruiz.jpg"
}
The image should refer to an image in public/avatars.
Date
The date is formatted as DD/MM/YYYY.
Status
An article's status may be either draft or published. A draft article is hidden in production.
Keywords
The keywords are used to find an article through the site's search feature.
Auto-generated content
The auto-generated docs content is created using tsdoc and API extractor. The source is the API documentation created by yarn build or yarn build-api. The output is placed in the gen folder.
Developing the docs
When developing the docs, any change to the content folder will cause the page to refresh. This is a little shitty but it mostly works.
Contribution
Please see our contributing guide. Found a bug? Please submit an issue.
License
The tldraw source code and its distributions are provided under the tldraw license. This license does not permit commercial use.
If you wish to use this project in commercial product, you need to purchase a commercial license. matPlease contact us at sales@tldraw.com for more inforion about obtaining a commercial license.
Trademarks
Copyright (c) 2023-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our trademark guidelines for info on acceptable usage.
Contact
Find us on Twitter at @tldraw or email sales@tldraw.com. You can also join our discord for quick help and support.