The AAS WorldWide Telescope user manual
Перейти к файлу
Peter Williams e3e77f7326
Merge pull request #3 from WorldWideTelescope/ga4
config.toml: update Google Analytics ID for GA4 migration
2023-08-03 21:16:55 +00:00
content No protocol-less URLs - they seem to confuse Zola now 2023-06-09 15:56:41 -04:00
orphan_images content/viewmenu/DateTimeSelection.jpg: presumably this was renamed 2020-04-10 10:38:06 -04:00
themes themes/wwtguide: update to latest 2023-06-09 15:44:12 -04:00
.gitignore Get some content in so I can explore Zola-ification 2020-04-08 18:04:17 -04:00
.gitmodules Import new wwtguide theme submodule 2020-04-09 08:31:34 -04:00
README.md README.md: updates for sponsorship 2023-06-09 15:47:18 -04:00
azure-pipelines.yml azure-pipelines.yml: version the publication destination 2020-04-10 11:33:42 -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 Powered by NumFOCUS

WWT User Manual: Source Code

This repository contains the source code for the WorldWide Telescope User Manual. The master branch of this repo gets published here:

https://docs.worldwidetelescope.org/user-manual/

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!

The WorldWide Telescope project uses an open governance model and is fiscally sponsored by NumFOCUS. Consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.

Quick Start for the Initiated

The manual 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.