https://github.com/reactivemarbles/dynamicdata.website

A static Website for DynamicData
https://github.com/reactivemarbles/dynamicdata.website

Last synced: 6 months ago
JSON representation

A static Website for DynamicData

• Host: GitHub
• URL: https://github.com/reactivemarbles/dynamicdata.website
• Owner: reactivemarbles
• License: mit
• Created: 2024-06-08T10:39:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-08T15:12:04.000Z (about 2 years ago)
• Last Synced: 2025-02-16T03:07:41.161Z (over 1 year ago)
• Language: C#
• Size: 2.21 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DynamicData.Website

[![BuildOnly](https://github.com/reactivemarbles/DynamicData.Website/actions/workflows/BuildOnly.yml/badge.svg)](https://github.com/reactivemarbles/DynamicData.Website/actions/workflows/BuildOnly.yml)

This is the source code for the [DynamicData](https://dynamic-data.org/) website. It's a static site generated by [DocFx](https://dotnet.github.io/docfx/index.html).

## Contributing

**Steps**

1. Fork the current project

2. Create a new branch, if needed

3. Clone the project

4. In order to build and host the docs do the following:

**Windows** -- Open command prompt and install the following tools:

- the DocFx tool `dotnet tool update -g docfx`

- the Nuke tool `dotnet tool install Nuke.GlobalTool --global`

 

- Open command prompt at the repository root folder, ensure that you have installed the DocFx tool and then run `docfx DynamicData/docfx.json --serve`

5. Wait several minutes while it installs dependencies and initializes (approx 5 mins).  It is ready when you see `Hit Ctrl-C to exit`

6. Browse the website on `localhost:8080`

---

To build the entire Website we use the `Nuke Build tool` you will need to install the tool so that you can run command line nuke commands using `dotnet tool install Nuke.GlobalTool --global`.

---

Once installed from the command prompt execute `Nuke` this will download and build the sources for the API section of the website, this takes around 35 minutes to compile and build the website with the API sections.

---

Once complete you can either execute `docfx DynamicData/docfx.json --serve` to run the site OR `Nuke BuildWebsite` to build the API only.

---

If you have generated the API section and wish to remove it on your local machine to enable the website to compile faster, run `nuke clean` and then run `docfx DynamicData/docfx.json --serve`