Skip to content

Commit 33f9ad7

Browse files
update readme - add info about running site locally
1 parent b122eed commit 33f9ad7

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

docs/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,30 @@ and included in the [StardustDocs/d.tree](./StardustDocs/d.tree) file.
1212

1313
Images all README files can be stored in [docs/imgs](./imgs).
1414

15+
## Running the Documentation Website Locally
16+
17+
⚠️ IFrames are not displayed when using the Writerside plugin preview. To view them correctly, you need to run the website locally.
18+
19+
### Option 1: Using IntelliJ IDEA Configurations
20+
21+
> Requires: `unzip` utility and **Python 3** installed in the environment. May not work properly on Windows.
22+
23+
1. Run the **Build Docs Website** configuration.
24+
2. Run the **Run Docs Website Locally** configuration.
25+
3. Open [http://localhost:8000/home.html](http://localhost:8000/home.html) in your browser.
26+
27+
### Option 2: Manual Steps
28+
29+
1. Go to `Writerside > DataFrame(d) > Export To > Build Docs Website` or find Writerside web archive build in IDEA configuration.
30+
2. Unzip the archive located at: `./build/ws/webHelpD2-all.zip`
31+
3. Start a local web server in the extracted folder (e.g., using Python or `http-server` utility):
32+
```bash
33+
python3 -m http.server
34+
# or
35+
http-server
36+
```
37+
4. Open [http://localhost:8000/home.html](http://localhost:8000/home.html) in your browser.
38+
1539
### Explainer dataframes
1640
`@TransformDataFrameExpressions` annotated test functions generate sample
1741
dataframe HTML files that can be used as iFrames on the documentation website.

tests/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs
77
by [Korro](https://github.com/devcrocod/korro).
88

99
This module might be merged with [:core](../core): [Issue #898](https://github.com/Kotlin/dataframe/issues/898).
10-
11-
See https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md for details of
12-
the Writerside docs generation.
10+
11+
Uses Kandy samples util.
12+
See https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md for more details.

0 commit comments

Comments
 (0)