Skip to content

Commit

Permalink
Finish beautifying docs
Browse files Browse the repository at this point in the history
  • Loading branch information
skygering committed Aug 6, 2024
1 parent 7ff4798 commit 6602fc1
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 20 deletions.
2 changes: 0 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ makedocs(;
deploy_url = "Caltech-OCTO.github.io/Subzero.jl",
),
pages=[
"Home" => "index.md",
"Introduction" => "introduction.md",
"API Reference" => "api.md",
],
Expand All @@ -22,5 +21,4 @@ makedocs(;

deploydocs(;
repo="https://github.com/Caltech-OCTO/Subzero.jl",
push_preview=true,
)
19 changes: 7 additions & 12 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```@raw html
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home
Expand All @@ -10,35 +11,29 @@ hero:
- theme: brand
text: Introduction
link: /introduction
- theme: alt
text: View on Github
link: https://github.com/Caltech-OCTO/Subzero.jl
- theme: alt
text: API Reference
link: /api
- theme: alt
text: View on Github
link: https://github.com/Caltech-OCTO/Subzero.jl
features:
- icon: <img width="64" height="64" src="https://rawcdn.githack.com/JuliaLang/julia-logo-graphics/f3a09eb033b653970c5b8412e7755e3c7d78db9e/images/juliadots.iconset/icon_512x512.png" alt="Julia code"/>
title: Pure Julia code
details: Fast, understandable, extensible functions
link: /introduction
link: "https://julialang.org/"
- icon: <img width="64" height="64" src="https://fredrikekre.github.io/Literate.jl/v2/assets/logo.png" />
title: Literate programming
details: Documented source code with examples!
link: /source/methods/clipping/cut
link: "https://github.com/fredrikekre/Literate.jl"
---

<p style="margin-bottom:2cm"></p>
<div class="vp-doc" style="width:80%; margin:auto">
# What is Subzero.jl?
Subzero is an easy-to-use Julia translation of Manucharyan and Montemuro’s model described in the paper “SubZero: A Sea Ice Model With an Explicit Representation of the Floe Life Cycle.” The model has been restructured to leverage Julia’s language abstractions for ease of setting up new simulation runs and allowing more types of simulations without code modifications. It has been designed for stand-alone simulations.

Subzero.jl was ported and restructured by Skylar Gering and originally developed by Georgy Manucharyan and Brandon Montemuro.

We welcome contributions, either as pull requests or discussion on issues!

</div>
```
6 changes: 0 additions & 6 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
# Introduction

Subzero is an easy-to-use Julia translation of Manucharyan and Montemuro’s model described in the paper “SubZero: A Sea Ice Model With an Explicit Representation of the Floe Life Cycle.” The model has been restructured to leverage Julia’s language abstractions for ease of setting up new simulation runs and allowing more types of simulations without code modifications. It has been designed for stand-alone simulations.

Subzero.jl was ported and restructured by Skylar Gering and originally developed by Georgy Manucharyan and Brandon Montemuro.

We welcome contributions, either as pull requests or discussion on issues!

## Main concepts

0 comments on commit 6602fc1

Please sign in to comment.