Skip to content

Commit 5821abf

Browse files
authored
Update README.md
1 parent 7dffe92 commit 5821abf

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@ This repository contains all documentation files in **Markdown (`.md`) format**,
2121

2222
To contribute or run the documentation locally, follow these steps:
2323

24-
### 1️⃣ Clone the Repository
24+
### 1️⃣ Create Directory and Clone the Repository
2525
```sh
26+
mkdir OpenSettings
2627
git clone https://github.com/OpenSettings/open-settings-docs.git
27-
cd open-settings-docs/docs
28+
cd OpenSettings/open-settings-docs/docs
2829
```
2930

3031
### 2️⃣ Install DocFX
@@ -33,13 +34,44 @@ If you don’t have **DocFX** installed, run:
3334
dotnet tool install -g docfx
3435
```
3536

37+
> ⚠️ **Warning:** PDF generation may require **Node.js**.
38+
You can download it from: [https://nodejs.org/en/download](https://nodejs.org/en/download)
39+
40+
If you don’t need PDF support, you can comment out or remove the following line from `./build.ps1`:
41+
42+
```ps1
43+
docfx pdf .\v1\docfx.json
44+
```
45+
3646
### 3️⃣ Build and Serve Documentation Locally
3747
```sh
38-
docfx build && docfx serve
48+
./build.ps1
3949
```
4050

4151
Open your browser and navigate to **[http://localhost:8080](http://localhost:8080)** to preview the documentation! 🚀
4252

53+
### 4️⃣ (Optional) Generate API Reference Files
54+
55+
To include API documentation:
56+
57+
1. Clone the main OpenSettings repo into the same root folder:
58+
59+
```sh
60+
git clone https://github.com/OpenSettings/open-settings.git
61+
```
62+
63+
2. Open `build.ps1` in a text editor and uncomment the following line by removing the `#`:
64+
65+
```ps1
66+
docfx metadata .\v1\docfx.json
67+
```
68+
69+
3. Run the build script again:
70+
71+
```sh
72+
./build.ps1
73+
```
74+
4375
## 💡 License
4476

4577
Licensed under the [OpenSettings License](https://opensettings.net/license).

0 commit comments

Comments
 (0)