A template/skeleton repository that can be used as a starting point to create a new SEFSC GitHub Documentation Site for deployment to https://sefsc.github.io (landing page coming soon).
See online documentation for working with this repository at: https://mattgrossi-noaa.github.io/SEFSC-documentation-quarto-skeleton/content/howto
Delete the 'SEFSC-documentation-quarto-skeleton' heading above, delete this comment and the remaining text above, modify the remaining README content below to be relevant to your documentation site, and make sure to change the Quarto site configuration files according to the instructions in the HOWTO/documentation. Once your site content looks ready to go, it can be pushed to the SEFSC GitHub Organization to be deployed.
Site URL: https://mattgrossi-noaa.github.io/SEFSC-documentation-quarto-skeleton
Requirements:
- Quarto
- Python
- Python packages (template demo only):
- matplotlib
- numpy
- markdown
- folium
- jupyter
Clone this repository:
git clone https://github.com/MattGrossi-NOAA/SEFSC-documentation-quarto-skeleton.git
Rename the resulting SEFSC-documentation-quarto-skeleton directory to a name of your choice, and follow further Getting Started section in the HOWTO documentation.
Further instructions for modifying and configuring your site can be found in the Editing and configuring your documentation site section of the HOWTO.
Make edits to the appropriate Markdown files in contents/.
More settings changes, including renaming the site URL to match your new repository name, should be made by editing the _metadata.yml file in the repository root. See the Add Content section of the HOWTO.
This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project content is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.
This content was created by U.S. Government employees as part of their official duties. This content is not subject to copyright in the United States (17 U.S.C. §105) and is in the public domain within the United States of America. Additionally, copyright is waived worldwide through the CC0 1.0 Universal public domain dedication.