This repository generates the UCAR SEA website from markdown files using the MkDocs platform along with the customized Material for MkDocs theme. The theme files have been customized to align with NCAR branding and colors and is available in the NCAR_mkdocs_material_themes.
- Fork this repository
- Clone it on your local computer and ensure the theme submodule is cloned too:
git clone [email protected]:<user>/sea-website.git
cd sea-website
git submodule init
git submodule update
- Install micromamba (or miniconda) if you do not have it already
- Create a mkdocs environment for testing the website locally:
micromamba env create -n mkdocs conda.yaml
- Activate the environment by running
micromamba activate mkdocs - Create and check out a new update branch using
git checkout -b branch-name - Make modifications to pages contained in
docs/subdirectory - If you add content that requires menu navigation, make sure to edit the
nav:section of mkdocs.yaml too - Preview your changes by running
mkdocs serveand opening the localhost link in your browser - Once satisfied 😸 with how your changes appear, add and commit modifications
- Push your branch to your fork on Github using
git push -u origin branch-name - Create the pull request on Github
This material is licensed under Creative Commons Attribution ShareAlike 4.0 (CC-BY-SA-4.0). You are free to:
-
Share — copy and redistribute the material in any medium or format for any purpose, even commercially.
-
Adapt — remix, transform, and build upon the material for any purpose, even commercially.
Under the following terms:
-
Attribution - You must give appropriate credit , provide a link to the license, and indicate if changes were made . You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
-
ShareAlike - If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. No additional restrictions - You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
See here for full details.