Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="apps/docs/images/logo-light.svg">
<source media="(prefers-color-scheme: light)" srcset="apps/docs/images/logo.svg">
<img width="200" alt="nimara logo" src="apps/docs/images/logo.svg">
<source media="(prefers-color-scheme: dark)" srcset="apps/docs/static/images/logo-light.svg">
<source media="(prefers-color-scheme: light)" srcset="apps/docs/static/images/logo.svg">
<img width="200" alt="nimara logo" src="apps/docs/static/images/logo.svg">
</picture>
</div>

Expand Down Expand Up @@ -34,11 +34,11 @@

- **Headless Architecture:** Nimara's headless architecture provides a flexible, easy-to-maintain, and ready-to-deploy solution for online businesses.

- **Next.js 15:** App router, React Server Components (RSC), Server Actions, Caching and Static Site Generation (SSG) support with Typescript setup.
- **Next.js 16:** App router, React Server Components (RSC), Server Actions, Caching and Static Site Generation (SSG) support with Typescript setup.

- **Shadcn UI/Tailwind CSS:** Nimara's UI uses [Shadcn UI](https://ui.shadcn.com/) and [Tailwind CSS](https://tailwindcss.com/), providing a modern and customizable design system.

- **Turborepo:** Nimara's monorepo is powered by [Turborepo](https://turbo.build/repo/docs/getting-started/introduction), a fast and scalable build system for monorepos. Automated tests with [Playwright](https://playwright.dev/) and setup for [Docs](https://nextra.site/) are included.
- **Turborepo:** Nimara's monorepo is powered by [Turborepo](https://turbo.build/repo/docs/getting-started/introduction), a fast and scalable build system for monorepos. Automated tests with [Playwright](https://playwright.dev/) and a [Docusaurus](https://docusaurus.io/) docs site are included.

- **Stripe Integration:** Nimara's storefront uses Stripe [Payment Element](https://docs.stripe.com/payments/payment-element) for secure payment processing.

Expand Down Expand Up @@ -162,18 +162,25 @@ git pull origin main

## Deploying the app to Vercel using a Terraform

A guide how to deploy the app to Vercel using a Terraform can be found here: [Using Terraform - Nimara Docs](https://docs.nimara.store/docs/quickstart/using-terraform).
A guide how to deploy the app to Vercel using Terraform can be found here: [Using Terraform - Nimara Docs](https://docs.nimara.store/docs/quickstart/using-terraform).

## 📚 Documentation

Comprehensive documentation is available in the `docs/` folder:
The public documentation site is built with Docusaurus from `apps/docs` and published at [docs.nimara.store](https://docs.nimara.store).

- **[Getting Started](./docs/HOW_TO_USE.md)** - Setup, installation, and basic usage
- **[Contributing Guide](./docs/CONTRIBUTING.md)** - How to contribute to the project
- **[Customization Guide](./docs/CUSTOMIZATION.md)** - Adapt Nimara for your needs
- **[Code Style Guide](./docs/CODE_STYLE_GUIDE.md)** - Coding standards and conventions
- **[Vision & Roadmap](./docs/VISION_AND_ROADMAP.md)** - Future plans and direction
- **[Contributors](./docs/CONTRIBUTORS.md)** - Community and contribution information
Start with these docs:

- **[Overview](https://docs.nimara.store)** - Nimara documentation homepage
- **[Running Locally](https://docs.nimara.store/docs/quickstart/running-locally)** - Setup, installation, and local development
- **[Storefront](https://docs.nimara.store/docs/quickstart/storefront)** - Deploy the storefront to production
- **[Environment Variables](https://docs.nimara.store/docs/quickstart/environment-variables)** - Configure required and optional environment variables
- **[Using Terraform](https://docs.nimara.store/docs/quickstart/using-terraform)** - Deploy the app to Vercel using Terraform

### Docs Versioning

The Docusaurus docs site uses `apps/docs/versions.json` as the source of truth for published documentation versions. `apps/docs/docusaurus.config.ts` derives `lastVersion` and the version dropdown from that file, so do not update versions in the config manually.

When releasing a new docs version, add the new version to the beginning of `apps/docs/versions.json` and make sure the matching `apps/docs/versioned_docs/version-<version>/` and `apps/docs/versioned_sidebars/version-<version>-sidebars.json` files are included.

## ❤️ Community & Contribution

Expand All @@ -186,7 +193,7 @@ You can also contribute to Nimara in various ways:
- Share your experiences or projects related to Nimara with the broader community through talks or blog posts.
- Support [popular feature requests](https://github.com/mirumee/nimara-ecommerce/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) by upvoting them.

For detailed contributing guidelines, please see [Contributing Guide](/CONTRIBUTING.md)
For detailed contributing guidelines, please see [Contributing Guide](./CONTRIBUTING.md)

### This wouldn't have been possible without your support

Expand Down
38 changes: 27 additions & 11 deletions apps/docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import type { VersionOptions } from "@docusaurus/plugin-content-docs";

import docsVersionsList from "./versions.json";
import { pluginLlmsTxt } from "./src/plugins/llms-txt";

const [latestDocsVersion] = docsVersionsList;

if (!latestDocsVersion) {
throw new Error("versions.json must contain at least one docs version.");
}

const docsVersions = Object.fromEntries(
docsVersionsList.map((version, index) => [
version,
index === 0
? { label: version }
: {
label: version,
path: version,
banner: "unmaintained" as const,
},
]),
) satisfies { [versionName: string]: VersionOptions };

const config: Config = {
title: "Nimara",
Expand Down Expand Up @@ -35,18 +58,9 @@ const config: Config = {
editUrl:
"https://github.com/mirumee/nimara-ecommerce/tree/main/apps/docs/",
routeBasePath: "/",
lastVersion: "1.15.0",
lastVersion: latestDocsVersion,
includeCurrentVersion: false,
versions: {
"1.15.0": {
label: "1.15.0",
},
"1.14.0": {
label: "1.14.0",
path: "1.14.0",
banner: "unmaintained",
},
},
versions: docsVersions,
},
blog: false,
theme: {
Expand All @@ -56,6 +70,8 @@ const config: Config = {
],
],

plugins: [pluginLlmsTxt],

themeConfig: {
image: "img/nimara-social.png",
navbar: {
Expand Down
13 changes: 7 additions & 6 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,20 @@
"typecheck": "tsc --noEmit"
},
"dependencies": {
"@docusaurus/core": "3.7.0",
"@docusaurus/preset-classic": "3.7.0",
"@docusaurus/theme-mermaid": "3.7.0",
"@docusaurus/core": "3.10.1",
"@docusaurus/preset-classic": "3.10.1",
"@docusaurus/theme-mermaid": "3.10.1",
"@mdx-js/react": "3.1.0",
"@mermaid-js/layout-elk": "0.2.1",
"clsx": "2.1.1",
"prism-react-renderer": "2.4.1",
"react": "18.3.1",
"react-dom": "18.3.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.7.0",
"@docusaurus/tsconfig": "3.7.0",
"@docusaurus/types": "3.7.0",
"@docusaurus/module-type-aliases": "3.10.1",
"@docusaurus/tsconfig": "3.10.1",
"@docusaurus/types": "3.10.1",
"typescript": "^5.9.3"
}
}
Loading
Loading