website

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #llm #machine-learning #rust #deep-learning #macos #nodejs #java #vue #pytorch #open-source

(★ 23)

The FlowFuse Website

website 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FlowFuse Website

[![Build Site](https://github.com/FlowFuse/website/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/FlowFuse/website/actions/workflows/build.yml)

This repository contains the source of the FlowFuse website.

It is hosted on Netlify with each commit to the `main` branch being automatically deployed to the live site.
This works by the [Build Site](.github/workflows/build.yml) action updating the `live` branch, committing onto it the
blueprints pulled from [FlowFuse/blueprint-library](https://github.com/FlowFuse/blueprint-library).

Netlify is then configured to watch the `live` branch for any changes, once detected, it will automatically pull the contents of this branch and deploy to our production site. Product documentation is not part of that snapshot — Netlify clones it directly from `main` of [FlowFuse/flowfuse](https://github.com/FlowFuse/flowfuse) during its own build.

## Repository structure

This repository is an **npm workspace** containing two projects:

| Directory | Purpose |
|-----------|---------|
| *(root)* | Legacy [Eleventy](https://www.11ty.dev/) site — all existing content lives here |
| `nuxt/` | New [Nuxt 3](https://nuxt.com/) frontend — pages are migrated here incrementally |

### Nuxt migration

The site is being migrated from Eleventy (11ty) to Nuxt 3 using the [Strangler Fig pattern](https://martinfowler.com/bliki/StranglerFigApplication.html). Nuxt acts as the front door on port 3000: pages that have been migrated are served directly by Nuxt; all other routes are transparently proxied to the legacy 11ty server on port 8080.

## Prerequisites

### Linux/MacOS
* `git` ([download](https://git-scm.com/downloads))
* `nodejs` ([download](https://nodejs.org/en/download/))
   * IMPORTANT: Developer tools should also be installed
* `jq` ([download](https://stedolan.github.io/jq/))

### Windows
* `git` and `gitbash` ([download](https://git-scm.com/downloads))
* `nodejs` ([download](https://nodejs.org/en/download/))
   * IMPORTANT: Select the [x] checkbox to install developer tools when asked
* `choco` 
   * Installed as part of the Node JS installer
   * Needed for installing `jq`
* `jq` ([download](https://stedolan.github.io/jq/))
   * From a administrator terminal, run `choco install jq`

## Running locally

Clone the repository, then install all dependencies (workspace packages are included automatically):

```bash
npm install
```

### Start both servers (recommended)

```bash
npm run dev
```

This starts three watchers concurrently:

| Process | URL | Description |
|---------|-----|-------------|
| Nuxt dev server | http://localhost:3000 | Front door — serves migrated pages and proxies everything else |
| 11ty dev server | http://localhost:8080 | Legacy site (proxied through Nuxt) |
| PostCSS watcher | — | Compiles Tailwind CSS for the legacy site |

**Use http://localhost:3000** as your development URL. The legacy 11ty server on port 8080 is also accessible directly if needed.

**Note**: the first time running this, 11ty may take a little while to process all images in the `/docs` and `/handbook` folders.

**Note**: if you have previously run `npm run build:nuxt`, clean the generated directories before starting dev or you will get a `spawn EBADF` error:

```bash
npm run clean:nuxt
```

### Legacy-only mode

To run just the legacy 11ty stack (equivalent to the old `npm start`):

```bash
npm start
```

This starts the full legacy stack on http://localhost:8080 including docs, blueprints, and PostCSS.

### Running FlowFuse Documentation

The documentation for FlowFuse is maintained in the core [FlowFuse repo](https://github.com/FlowFuse/flowfuse). To run a local version of the documentation, clone that repository alongside this one:

```
/<parent_directory>
    /website
    /flowfuse
```

The `npm run dev` (and `npm start`) commands will retrieve the documentation from that folder and inject them into the site automatically. The docs will be available at http://localhost:3000/docs.

Nothing needs configuring for that to happen. Every build resolves the docs in this order, and logs which one it used:

| Order | Source | Used when |
|-------|--------|-----------|
| 1 | `FLOWFUSE_DOCS_LOCAL=/path/to/flowfuse` | The env var is set. A path that does not exist is an error, not a fallback. |
| 2 | A sibling checkout: `../flowfuse`, `../flowforge` or `../dev-env/packages/flowfuse` | One of those has a `docs/` directory. This is what CI relies on. |
| 3 | A clone of `FLOWFUSE_DOCS_REF` (default `main`) | Nothing above applied. This is what Netlify production deploys use. |

`npm run docs` runs that resolution on its own, without a full build, writing `nuxt/content/docs` and `nuxt/public/docs`. Both are generated, and neither is committed on `main`.

## llms.txt

`/llms.txt` (and `/llms-full.txt`) are generated by the [`nuxt-llms`](https://github.com/nuxtlabs/nuxt-llms) module, configured in `nuxt/nuxt.config.ts` under the `llms` key. Sections are built from `@nuxt/content` collections (`docs`, `blog`, `changelog`, `ebooks`, `whitepapers`) plus a small hardcoded list of standalone Nuxt routes (pricing, integrations, etc.) that aren't backed by a collection.

The `handbook` collection is deliberately excluded — it's internal company documentation, not product content, so it has no `contentCollection` section here. Content still served by the legacy Eleventy site (customer-stories, use-cases, platform, etc.) is invisible to `@nuxt/content` and so is also absent from `llms.txt` until those pages are migrated to Nuxt.

## How to add blog posts

See the [Blog section of the Marketing Handbook](https://flowfuse.com/handbook/marketing/content-strategy/blog/) for instructions on writing and publishing blog posts.

## Updating the FlowFuse Documentation

When the website is built it will include the documentation
from the `main` branch of the [FlowFuse/flowfuse](https://github.com/FlowFuse/flowfuse)
repository.

To make a documentation update *and* make it live on the website:

1. PR the documentation update to the `main` branch of [FlowFuse/flowfuse](https://github.com/FlowFuse/flowfuse)
2. Get the PR reviewed and merged in the normal manner.

That repository's `Publish Documentation` workflow builds this site against the PR's docs before it can merge, then
triggers a website rebuild once it lands. A rebuild can also be started by hand with 'Run workflow' on
[this page](https://github.com/FlowFuse/website/actions/workflows/build.yml).

## Acknowledgements

This setup was inspired by:

- [Eleventy Base Blog starter repository](https://github.com/11ty/eleventy-base-blog)
 - [Oxide.Computer's website setup](https://github.com/oxidecomputer/website)

website

website 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

website

website 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README