Skip to content

Commit f03656d

Browse files
mikecousinsmikecousins
committed
Adding docs site using Syntax template
1 parent bf6f2d1 commit f03656d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+13089
-25
lines changed

‎apps/docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.next/

‎apps/docs/CHANGELOG.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
# Changelog
2+
3+
## 2025-03-22
4+
5+
- Update template to Tailwind CSS v4.0.15
6+
7+
## 2025-03-18
8+
9+
- Fix heading spacing in callout component ([#1677](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1677))
10+
11+
## 2025-02-10
12+
13+
- Update template to Tailwind CSS v4.0.6
14+
15+
## 2025-01-23
16+
17+
- Update template to Tailwind CSS v4.0
18+
19+
## 2024-06-21
20+
21+
- Bump Headless UI dependency to v2.1
22+
23+
## 2024-06-18
24+
25+
- Update `prettier` and `prettier-plugin-tailwindcss` dependencies
26+
27+
## 2024-05-31
28+
29+
- Fix `npm audit` warnings
30+
31+
## 2024-05-07
32+
33+
- Bump Headless UI dependency to v2.0
34+
35+
## 2024-01-17
36+
37+
- Fix `sharp` dependency issues ([#1549](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1549))
38+
39+
## 2024-01-10
40+
41+
- Update Tailwind CSS, Next.js, Prettier, TypeScript, ESLint, and other dependencies
42+
- Update Tailwind `darkMode` setting to new `selector` option
43+
44+
## 2023-10-23
45+
46+
- Bump Markdoc dependencies
47+
- Remove unnecessary Markdoc configuration in `next.config.mjs` file
48+
49+
## 2023-09-07
50+
51+
- Added TypeScript version of template
52+
53+
## 2023-09-05
54+
55+
- Add scroll position buffer for table of contents ([#1499](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1499))
56+
57+
## 2023-08-15
58+
59+
- Bump Next.js dependency
60+
61+
## 2023-08-11
62+
63+
- Port template to Next.js app router
64+
65+
## 2023-07-24
66+
67+
- Fix search rendering bug in Safari ([#1470](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1470))
68+
69+
## 2023-07-18
70+
71+
- Add 404 page
72+
- Sort imports
73+
74+
## 2023-05-16
75+
76+
- Bump Next.js dependency
77+
78+
## 2023-05-15
79+
80+
- Replace Algolia DocSearch with basic built-in search ([#1395](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1395))
81+
82+
## 2023-04-11
83+
84+
- Bump Next.js dependency
85+
86+
## 2023-04-05
87+
88+
- Fix listbox console error ([#1442](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1442))
89+
90+
## 2023-03-29
91+
92+
- Bump Tailwind CSS and Prettier dependencies
93+
- Sort classes
94+
95+
## 2023-03-22
96+
97+
- Bump Headless UI dependency
98+
99+
## 2023-02-15
100+
101+
- Remove `passive` option from `removeEventListener`
102+
103+
## 2023-02-02
104+
105+
- Bump Headless UI dependency
106+
- Sort imports
107+
108+
## 2022-11-04
109+
110+
- Bump Tailwind CSS and Next.js dependencies
111+
112+
## 2022-09-27
113+
114+
- Update Headless UI, Next.js, Markdoc, and Autoprefixer dependencies
115+
- Fix nav sidebar overflow issue ([#1337](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1337))
116+
117+
## 2022-09-19
118+
119+
- Fix bug with theme switching ([#1325](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1325))
120+
121+
## 2022-09-09
122+
123+
- Update Next.js dependency
124+
125+
## 2022-09-07
126+
127+
- Update Headless UI dependency
128+
129+
## 2022-09-01
130+
131+
- Update Tailwind CSS, Next.js, Headless UI, ESLint, and other dependencies
132+
133+
## 2022-08-16
134+
135+
- Enable experimental Next.js `scrollRestoration` flag
136+
137+
## 2022-07-26
138+
139+
- Fix issue with table customizations ([#1278](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1278))
140+
141+
## 2022-07-25
142+
143+
- Update Next.js and React dependencies
144+
145+
## 2022-07-11
146+
147+
- Add `.env.example` file ([#1260](https://github.com/tailwindlabs/tailwind-plus-issues/issues/1260))
148+
149+
## 2022-07-07
150+
151+
- Fix duplicated empty lines in code blocks
152+
153+
## 2022-07-06
154+
155+
- Replace `next/image` with `next/future/image`
156+
157+
## 2022-06-23
158+
159+
- Initial release

‎apps/docs/LICENSE.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Tailwind Plus License
2+
3+
## Personal License
4+
5+
Tailwind Labs Inc. grants you an on-going, non-exclusive license to use the Components and Templates.
6+
7+
The license grants permission to **one individual** (the Licensee) to access and use the Components and Templates.
8+
9+
You **can**:
10+
11+
- Use the Components and Templates to create unlimited End Products.
12+
- Modify the Components and Templates to create derivative components and templates. Those components and templates are subject to this license.
13+
- Use the Components and Templates to create unlimited End Products for unlimited Clients.
14+
- Use the Components and Templates to create End Products where the End Product is sold to End Users.
15+
- Use the Components and Templates to create End Products that are open source and freely available to End Users.
16+
17+
You **cannot**:
18+
19+
- Use the Components and Templates to create End Products that are designed to allow an End User to build their own End Products using the Components and Templates or derivatives of the Components and Templates.
20+
- Re-distribute the Components and Templates or derivatives of the Components and Templates separately from an End Product, neither in code or as design assets.
21+
- Share your access to the Components and Templates with any other individuals.
22+
- Use the Components and Templates to produce anything that may be deemed by Tailwind Labs Inc, in their sole and absolute discretion, to be competitive or in conflict with the business of Tailwind Labs Inc.
23+
24+
### Example usage
25+
26+
Examples of usage **allowed** by the license:
27+
28+
- Creating a personal website by yourself.
29+
- Creating a website or web application for a client that will be owned by that client.
30+
- Creating a commercial SaaS application (like an invoicing app for example) where end users have to pay a fee to use the application.
31+
- Creating a commercial self-hosted web application that is sold to end users for a one-time fee.
32+
- Creating a web application where the primary purpose is clearly not to simply re-distribute the components (like a conference organization app that uses the components for its UI for example) that is free and open source, where the source code is publicly available.
33+
34+
Examples of usage **not allowed** by the license:
35+
36+
- Creating a repository of your favorite Tailwind Plus components or templates (or derivatives based on Tailwind Plus components or templates) and publishing it publicly.
37+
- Creating a React or Vue version of Tailwind Plus and making it available either for sale or for free.
38+
- Create a Figma or Sketch UI kit based on the Tailwind Plus component designs.
39+
- Creating a "website builder" project where end users can build their own websites using components or templates included with or derived from Tailwind Plus.
40+
- Creating a theme, template, or project starter kit using the components or templates and making it available either for sale or for free.
41+
- Creating an admin panel tool (like [Laravel Nova](https://nova.laravel.com/) or [ActiveAdmin](https://activeadmin.info/)) that is made available either for sale or for free.
42+
43+
In simple terms, use Tailwind Plus for anything you like as long as it doesn't compete with Tailwind Plus.
44+
45+
### Personal License Definitions
46+
47+
Licensee is the individual who has purchased a Personal License.
48+
49+
Components and Templates are the source code and design assets made available to the Licensee after purchasing a Tailwind Plus license.
50+
51+
End Product is any artifact produced that incorporates the Components or Templates or derivatives of the Components or Templates.
52+
53+
End User is a user of an End Product.
54+
55+
Client is an individual or entity receiving custom professional services directly from the Licensee, produced specifically for that individual or entity. Customers of software-as-a-service products are not considered clients for the purpose of this document.
56+
57+
## Team License
58+
59+
Tailwind Labs Inc. grants you an on-going, non-exclusive license to use the Components and Templates.
60+
61+
The license grants permission for **up to 25 Employees and Contractors of the Licensee** to access and use the Components and Templates.
62+
63+
You **can**:
64+
65+
- Use the Components and Templates to create unlimited End Products.
66+
- Modify the Components and Templates to create derivative components and templates. Those components and templates are subject to this license.
67+
- Use the Components and Templates to create unlimited End Products for unlimited Clients.
68+
- Use the Components and Templates to create End Products where the End Product is sold to End Users.
69+
- Use the Components and Templates to create End Products that are open source and freely available to End Users.
70+
71+
You **cannot**:
72+
73+
- Use the Components or Templates to create End Products that are designed to allow an End User to build their own End Products using the Components or Templates or derivatives of the Components or Templates.
74+
- Re-distribute the Components or Templates or derivatives of the Components or Templates separately from an End Product.
75+
- Use the Components or Templates to create End Products that are the property of any individual or entity other than the Licensee or Clients of the Licensee.
76+
- Use the Components or Templates to produce anything that may be deemed by Tailwind Labs Inc, in their sole and absolute discretion, to be competitive or in conflict with the business of Tailwind Labs Inc.
77+
78+
### Example usage
79+
80+
Examples of usage **allowed** by the license:
81+
82+
- Creating a website for your company.
83+
- Creating a website or web application for a client that will be owned by that client.
84+
- Creating a commercial SaaS application (like an invoicing app for example) where end users have to pay a fee to use the application.
85+
- Creating a commercial self-hosted web application that is sold to end users for a one-time fee.
86+
- Creating a web application where the primary purpose is clearly not to simply re-distribute the components or templates (like a conference organization app that uses the components or a template for its UI for example) that is free and open source, where the source code is publicly available.
87+
88+
Examples of use **not allowed** by the license:
89+
90+
- Creating a repository of your favorite Tailwind Plus components or template (or derivatives based on Tailwind Plus components or templates) and publishing it publicly.
91+
- Creating a React or Vue version of Tailwind Plus and making it available either for sale or for free.
92+
- Creating a "website builder" project where end users can build their own websites using components or templates included with or derived from Tailwind Plus.
93+
- Creating a theme or template using the components or templates and making it available either for sale or for free.
94+
- Creating an admin panel tool (like [Laravel Nova](https://nova.laravel.com/) or [ActiveAdmin](https://activeadmin.info/)) that is made available either for sale or for free.
95+
- Creating any End Product that is not the sole property of either your company or a client of your company. For example your employees/contractors can't use your company Tailwind Plus license to build their own websites or side projects.
96+
97+
### Team License Definitions
98+
99+
Licensee is the business entity who has purchased a Team License.
100+
101+
Components and Templates are the source code and design assets made available to the Licensee after purchasing a Tailwind Plus license.
102+
103+
End Product is any artifact produced that incorporates the Components or Templates or derivatives of the Components or Templates.
104+
105+
End User is a user of an End Product.
106+
107+
Employee is a full-time or part-time employee of the Licensee.
108+
109+
Contractor is an individual or business entity contracted to perform services for the Licensee.
110+
111+
Client is an individual or entity receiving custom professional services directly from the Licensee, produced specifically for that individual or entity. Customers of software-as-a-service products are not considered clients for the purpose of this document.
112+
113+
## Enforcement
114+
115+
If you are found to be in violation of the license, access to your Tailwind Plus account will be terminated, and a refund may be issued at our discretion. When license violation is blatant and malicious (such as intentionally redistributing the Components or Templates through private warez channels), no refund will be issued.
116+
117+
The copyright of the Components and Templates is owned by Tailwind Labs Inc. You are granted only the permissions described in this license; all other rights are reserved. Tailwind Labs Inc. reserves the right to pursue legal remedies for any unauthorized use of the Components or Templates outside the scope of this license.
118+
119+
## Liability
120+
121+
Tailwind Labs Inc.’s liability to you for costs, damages, or other losses arising from your use of the Components or Templates — including third-party claims against you — is limited to a refund of your license fee. Tailwind Labs Inc. may not be held liable for any consequential damages related to your use of the Components or Templates.
122+
123+
This Agreement is governed by the laws of the Province of Ontario and the applicable laws of Canada. Legal proceedings related to this Agreement may only be brought in the courts of Ontario. You agree to service of process at the e-mail address on your original order.
124+
125+
## Questions?
126+
127+
Unsure which license you need, or unsure if your use case is covered by our licenses?
128+
129+
Email us at [[email protected]](mailto:[email protected]) with your questions.

‎apps/docs/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Syntax
2+
3+
Syntax is a [Tailwind Plus](https://tailwindcss.com/plus) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org).
4+
5+
## Getting started
6+
7+
To get started with this template, first install the npm dependencies:
8+
9+
```bash
10+
npm install
11+
```
12+
13+
Next, run the development server:
14+
15+
```bash
16+
npm run dev
17+
```
18+
19+
Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
20+
21+
## Customizing
22+
23+
You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.
24+
25+
## Global search
26+
27+
This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.
28+
29+
This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/markdoc/search.mjs` file.
30+
31+
## License
32+
33+
This site template is a commercial product and is licensed under the [Tailwind Plus license](https://tailwindcss.com/plus/license).
34+
35+
## Learn more
36+
37+
To learn more about the technologies used in this site template, see the following resources:
38+
39+
- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
40+
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
41+
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
42+
- [Markdoc](https://markdoc.io) - the official Markdoc documentation
43+
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
44+
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation

‎apps/docs/next-env.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/// <reference types="next" />
2+
/// <reference types="next/image-types/global" />
3+
4+
// NOTE: This file should not be edited
5+
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

‎apps/docs/next.config.mjs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import withMarkdoc from '@markdoc/next.js'
2+
3+
import withSearch from './src/markdoc/search.mjs'
4+
5+
/** @type {import('next').NextConfig} */
6+
const nextConfig = {
7+
pageExtensions: ['js', 'jsx', 'md', 'ts', 'tsx'],
8+
}
9+
10+
export default withSearch(
11+
withMarkdoc({ schemaPath: './src/markdoc' })(nextConfig),
12+
)

0 commit comments

Comments
 (0)