Skip to content
Open
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
60 changes: 50 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,75 @@
![FND Github-Docs](https://user-images.githubusercontent.com/14855515/161173790-970fe580-fe58-4a6d-8934-2d501e2b1299.png)

# Website
# FND Website (Docusaurus 2)

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This repository contains the source for the FND documentation website built with Docusaurus 2.

## Prerequisites

- Node.js 18+ (recommended)
- Yarn (v1) or npm
- Git

Development container: Ubuntu 24.04.2 LTS.

## Installation

```console
Install dependencies:

```bash
yarn install
# or
npm install
```

## Local Development
## Local development

```console
Start the dev server:

```bash
yarn start
# or
npm run start
```

The dev server runs at http://localhost:3000 by default. If you need to open the site in the host's default browser from the devcontainer, run:

```bash
"$BROWSER" http://localhost:3000
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Most changes are hot-reloaded; no restart required for content edits.

## Build

```console
Create a production build:

```bash
yarn build
# or
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
Static output is generated into the `build` directory.

## Deployment

```console
Example for GitHub Pages:

```bash
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Adjust deployment method to your hosting provider as needed.

## Troubleshooting

- If packages fail to install, remove `node_modules` and reinstall.
- Ensure Node.js version matches project expectations: `node -v`.
- Check Docusaurus docs: https://v2.docusaurus.io/docs/

## Contributing

- Update docs under `docs/` and sidebar in `sidebars.js`.
- Run `yarn start` to preview changes locally.
- Open a PR with a clear description of changes and testing steps.