Skip to content

Commit c515602

Browse files
tyson-swetnamclaude
andcommitted
Update README.md to reflect Zensical migration
Updated documentation build instructions from MkDocs Material to Zensical, including new commands (zensical serve/build), configuration file reference (zensical.toml), and corrected typos. Co-Authored-By: Claude Sonnet 4.5 (1M context) <noreply@anthropic.com>
1 parent ddf8312 commit c515602

1 file changed

Lines changed: 26 additions & 17 deletions

File tree

README.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,47 @@
1-
A special thanks to [Mojib Wali](https://github.com/mb-wali) of [CyVerse-Austria](https://www.tugraz.at/sites/cyverse/home), Graz University of Technology, Austria, for creating these Material MkDocs pages for the global CyVerse developer and maintainer community!
1+
A special thanks to [Mojib Wali](https://github.com/mb-wali) of [CyVerse-Austria](https://www.tugraz.at/sites/cyverse/home), Graz University of Technology, Austria, for creating the initial Material MkDocs pages for the global CyVerse developer and maintainer community!
22

33
CyVerse Core Software Documentation
44
===================================
55

6-
These documents are for the deployment and maintenence of [CyVerse](https://cyverse.org)
6+
These documents are for the deployment and maintenance of [CyVerse](https://cyverse.org)
77

8-
## MkDocs deploy GitHub Action
8+
## Zensical Static Site Generator
99

10-
The `main` branch uses [deploy-mkdocs](https://github.com/marketplace/actions/deploy-mkdocs) GitHub Action.
10+
This documentation is built using [Zensical](https://zensical.com), a modern static site generator from the team behind Material for MkDocs. The site uses Zensical's "classic" theme which provides the familiar Material for MkDocs appearance with enhanced features.
1111

12-
Do not commit changes directly to the `main` branch unless necessary. Please commit your updates to the `mkdocs` branch, test on CodeSpaces or locally, and then commit those merges back to `main`.
12+
## GitHub Actions Deployment
1313

14-
Commits to `main` will trigget the Action which re-builds and deploys the website to https://docs.cyverse.org -- which is publicly available.
14+
The `main` branch uses GitHub Actions to automatically build and deploy the documentation.
1515

16-
## Rendered with the Material Theme
16+
Do not commit changes directly to the `main` branch unless necessary. Please commit your updates to the `mkdocs` branch, test on CodeSpaces or locally, and then commit those merges back to `main`.
1717

18-
To change to [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) theme, change [Action](./github/workflows/main.yml) to `@master` and set `theme: material` in the [mkdocs.yml](./mkdocs.yml):
18+
Commits to `main` will trigger the Action which re-builds and deploys the website to https://docs.cyverse.org -- which is publicly available.
1919

20-
```
21-
theme:
22-
name: material
23-
```
20+
## Configuration
2421

25-
## Build
22+
The documentation is configured using `zensical.toml` (TOML format) instead of the traditional `mkdocs.yml`. This provides better configuration management and access to Zensical-specific features.
2623

27-
```
24+
## Local Development
25+
26+
```bash
2827
git clone https://github.com/cyverse/docs
2928
cd docs
3029
pip install -r requirements.txt
31-
python -m mkdocs serve
30+
zensical serve
3231
```
3332

34-
After compiling the new pages the service will open on `http://localhost:8000/docs`
33+
After starting the development server, the site will open at `http://localhost:8000`
3534

3635
Open in browser and view
3736

38-
Recommended: two monitors for easier display while working on docs.
37+
Recommended: two monitors for easier display while working on docs.
38+
39+
## Building
40+
41+
To build the static site:
42+
43+
```bash
44+
zensical build
45+
```
46+
47+
Output will be in the `./site` directory.

0 commit comments

Comments
 (0)