The AAS WorldWide Telescope Do-It-Yourself Planetarium Dome Guide
Перейти к файлу
Peter Williams 8854941c50
Merge pull request #2 from WorldWideTelescope/fix
Layout fix
2024-06-11 15:12:21 +00:00
content Sponsorship branding updates 2024-06-11 10:58:38 -04:00
orphan_images orphan_images: some unclaimed images 2020-04-11 18:37:06 -04:00
static content/_index.md: found the missing images 2020-04-12 13:56:34 -04:00
themes themes/wwtguide: update to latest 2024-06-11 10:56:12 -04:00
.gitignore Zola-ify 2020-04-11 18:12:40 -04:00
.gitmodules Zola-ify 2020-04-11 18:12:40 -04:00
README.md Sponsorship branding updates 2024-06-11 10:58:38 -04:00
azure-pipelines.yml Zola-ify 2020-04-11 18:12:40 -04:00
config.toml config.toml: update Google Analytics ID for GA4 migration 2023-08-03 17:00:15 -04:00

README.md

Build Status

WWT D.I.Y. Planetarium Dome Guide: Source Code

This repository contains the source code for the WWT Do-It-Yourself Planetarium Dome Guide. The master branch of this repo gets published here:

https://docs.worldwidetelescope.org/diy-planetarium-dome/1/

If youre just interested in the documentation itself, you should go to that website. If youre interested in contributing to this documentation, youve come to the right place!

Quick Start for the Initiated

The guide is a static site written in CommonMark Markdown and processed with Zola. Zola is distributed as a single executable so it is ridiculously easy to install.

This repository is themed by referencing zola-wwtguide as a submodule, so upon first checkout youll have to run:

git submodule update --init

Once everything is set up, all you have to do is run

zola serve

to build the site and serve it locally for testing. The command zola check will check the build and verify that outgoing links are valid. Zola has lots of documentation.

Merges to master will be published automatically using WWTs continuous deployment infrastructure.

Contributing

Contributions are welcome! If youre new to the project, please see the WWT Contributors Guide and the WWT Code of Conduct. We operate with a standard fork-and-pull model.

Acknowledgments

Work on the WorldWide Telescope system has been supported by the American Astronomical Society (AAS), the .NET Foundation, and other partners. See the WWT user website for details.