|
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! |
2 | 2 |
|
3 | 3 | CyVerse Core Software Documentation |
4 | 4 | =================================== |
5 | 5 |
|
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) |
7 | 7 |
|
8 | | -## MkDocs deploy GitHub Action |
| 8 | +## Zensical Static Site Generator |
9 | 9 |
|
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. |
11 | 11 |
|
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 |
13 | 13 |
|
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. |
15 | 15 |
|
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`. |
17 | 17 |
|
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. |
19 | 19 |
|
20 | | -``` |
21 | | -theme: |
22 | | - name: material |
23 | | -``` |
| 20 | +## Configuration |
24 | 21 |
|
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. |
26 | 23 |
|
27 | | -``` |
| 24 | +## Local Development |
| 25 | + |
| 26 | +```bash |
28 | 27 | git clone https://github.com/cyverse/docs |
29 | 28 | cd docs |
30 | 29 | pip install -r requirements.txt |
31 | | -python -m mkdocs serve |
| 30 | +zensical serve |
32 | 31 | ``` |
33 | 32 |
|
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` |
35 | 34 |
|
36 | 35 | Open in browser and view |
37 | 36 |
|
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