Icons

DHI · Mar 5, 2024 · 92a01f8 · 92a01f8
1 parent 8c94ebb
commit 92a01f8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 18 deletions.
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -58,7 +58,7 @@ website:
           - examples/Time-interpolation.qmd
           - examples/Generic.qmd
       - text: Design philosophy
-        href: design.md
+        href: design.qmd
       - text: API Reference
         href: api/index.qmd
 

diff --git a/docs/design.md → docs/design.qmd b/docs/design.md → docs/design.qmd
@@ -1,33 +1,24 @@
 # Design philosophy
 
-* [Easy to use](#easy-to-use)
-* [Familiar](#familiar)
-* [Easy to install](#easy-to-install)
-* [Easy to get started](#easy-to-get-started)
-* [Open Source](#open-source)
-* [Easy to collaborate](#easy-to-collaborate)
-* [Reproducible](#reproducible)
-* [Easy access to new features](#easy-access-to-new-features)
 
-
-## Easy to use
+## {{< fa code >}} Easy to use
 
 Common operations such as reading a file should only need a few lines of code.
 
 Make extensive use of existing standard libraries for scientific computing such as numpy, matplotlib and pandas.
 
 
-## Familiar
+## {{< fa brands python >}} Familiar
 
 MIKE IO aims to use a syntax familiar to users of scientific computing libraries such as NumPy, Pandas and xarray.
 
-## Easy to install
+## {{< fa download >}} Easy to install
 
 ```bash
 $ pip install mikeio
 ```
 
-## Easy to get started
+## {{< fa book >}} Easy to get started
 By providing many examples to cut/paste from.
 
 Examples are available in two forms:
@@ -36,16 +27,16 @@ Examples are available in two forms:
 * [Unit tests](https://github.com/DHI/mikeio/tree/main/tests)
 
 
-## Open Source
+## {{< fa brands osi >}} Open Source
 MIKE IO is an open source project licensed under the [BSD-3 license](https://github.com/DHI/mikeio/blob/main/License.txt).
 The software is provided free of charge with the source code available for inspection and modification.
 
 Contributions are welcome, more details can be found in our [contribution guidelines](https://github.com/DHI/mikeio/blob/main/CONTRIBUTING.md).
 
-## Easy to collaborate
+## {{< fa comments >}} Easy to collaborate
 By developing MIKE IO on GitHub along with a completely open discussion, we believe that the collaboration between developers and end-users results in a useful library.
 
-## Reproducible
+## {{< fa list-ol >}} Reproducible
 By providing the historical versions of MIKE IO on PyPI it is possible to reproduce the behaviour of an older existing system, based on an older version.
 
 **Install specific version**
@@ -54,7 +45,7 @@ By providing the historical versions of MIKE IO on PyPI it is possible to reprod
 pip install mikeio==1.4.0
 ```
 
-## Easy access to new features
+## {{< fa brands github >}} Easy access to new features
 Features are being added all the time, by developers at DHI in offices all around the globe as well as external contributors using MIKE IO in their work.
 These new features are always available from the [main branch on GitHub](https://github.com/DHI/mikeio) and thanks to automated testing, it is always possible to verify that the tests passes before downloading a new development version.