docs: replace pkgdown by altdoc

riatelab · Jan 22, 2025 · 5006ce0 · 5006ce0
1 parent e22f11c
commit 5006ce0
Show file tree

Hide file tree

Showing 63 changed files with 281 additions and 151 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -17,10 +17,14 @@
 ^README\.Rmd$
 ^test
 ^\.github$
-^vignettes/web_only/*
 ^CITATION\.cff$
 ^codecov\.yml$
 ^map.png
 ^note.md
 ^LICENSE\.md$
 ^CONTRIBUTING\.md$
+^altdoc$
+^vignettes/how_to*
+^vignettes/cheat_sheet.Rmd
+^vignettes/fig/wo_*
+^vignettes/fig/mapsf_cheatsheet.*
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
diff --git a/.gitignore b/.gitignore
@@ -24,3 +24,4 @@ docs
 /Meta/
 
 note.md
+altdoc/freeze.rds
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -46,13 +46,14 @@ Imports:
 Suggests: 
     terra,
     Ckmeans.1d.dp,
-    png, 
+    png,
     jpeg,
     lwgeom,
     knitr,
     rmarkdown,
     tinytest,
-    covr
+    covr,
+    altdoc
 Encoding: UTF-8
 RoxygenNote: 7.3.2
 VignetteBuilder: knitr

diff --git a/altdoc/.nojekyll b/altdoc/.nojekyll
diff --git a/altdoc/docsify.html b/altdoc/docsify.html
@@ -0,0 +1,47 @@
+<!-- index.html -->
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <meta charset="UTF-8">
+  <!-- Theme: Simple (light + dark) -->
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
+
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '$ALTDOC_PACKAGE_NAME',
+      repo: '$ALTDOC_PACKAGE_URL_GITHUB',
+      loadSidebar: true,
+      subMaxLevel: 1,
+      search: {
+        placeholder: 'Search',
+        depth: 3,
+      },
+      auto2top: true,
+      copyCode: {
+        buttonText : 'Copy',
+        errorText  : 'Error',
+        successText: 'Copied'
+      },
+      plugins: [
+        function(hook) {
+          var footer = ["<a href='$ALTDOC_PACKAGE_URL'> <code> $ALTDOC_PACKAGE_NAME </code> v. $ALTDOC_PACKAGE_VERSION </a> | Documentation made with <a href='https://altdoc.etiennebacher.com/'> <code> altdoc </code> v. $ALTDOC_VERSION</a>"].join('');
+
+          hook.afterEach(function(html) {
+            return html + footer;
+          });
+        }
+      ]
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+  <script src="//cdn.jsdelivr.net/npm/[email protected]/components/prism-r.js"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+</body>
+</html>
diff --git a/altdoc/docsify.md b/altdoc/docsify.md
@@ -0,0 +1,41 @@
+* [Home](/)
+* Vignettes 
+  - [Cheat sheet](vignettes/cheat_sheet)
+  - [Get started with mapsf](vignettes/mapsf)
+  - [How to export maps](vignettes/how_to_export_maps)
+  - [How to use themes](vignettes/how_to_use_themes)
+  - [How to create faceted maps](vignettes/how_to_create_faceted_maps)
+  - [How to create inset maps](vignettes/how_to_create_inset_maps)
+  - [How to use a custom font](vignettes/how_to_use_a_custom_font_family)
+* Functions 
+  - Symbology
+    - [mf_map()](man/mf_map)
+    - [mf_label()](man/mf_label)
+    - [mf_raster()](man/mf_raster)
+    - [mf_graticule()](man/mf_graticule)
+  - Map layout
+    - [mf_theme()](man/mf_theme)
+    - [mf_shadow()](man/mf_shadow)
+    - [mf_background()](man/mf_background)
+    - [mf_legend()](man/mf_legend)
+    - [mf_annotation()](man/mf_annotation)
+    - [mf_arrow()](man/mf_arrow)
+    - [mf_credits()](man/mf_credits)
+    - [mf_layout()](man/mf_layout)
+    - [mf_title()](man/mf_title)
+    - [mf_scale()](man/mf_scale)
+    - [mf_inset_*()](man/mf_inset_on)
+    - [mf_worldmap()](man/mf_worldmap)
+  - Utility
+    - [mf_export()](man/mf_export)
+    - [mf_distr()](man/mf_distr)
+    - [mf_get_links()](man/mf_links)
+    - [mf_get_pal()](man/mf_get_pal)
+    - [mf_get_breaks()](man/mf_get_breaks)
+    - [mf_get_mtq()](man/mf_get_mtq)
+    - [mf_get_ratio()](man/mf_get_ratio)
+    - [mf_get_pencil()](man/mf_get_pencil)
+    - [mf_get_borders()](man/mf_get_borders)
+* [News]($ALTDOC_NEWS)
+* [Licence]($ALTDOC_LICENCE)
+* [Citation]($ALTDOC_CITATION)
diff --git a/altdoc/pkgdown.yml b/altdoc/pkgdown.yml
@@ -0,0 +1,4 @@
+urls:
+  reference: https:/riatelab.github.io/mapsf/man
+  article: https:/riatelab.github.io/mapsf/vignettes
+
diff --git a/altdoc/preamble_man_qmd.yml b/altdoc/preamble_man_qmd.yml
@@ -0,0 +1,6 @@
+---
+format:
+  md:
+    prefer-html: true
+---
+
diff --git a/altdoc/preamble_vignettes_qmd.yml b/altdoc/preamble_vignettes_qmd.yml
@@ -0,0 +1,6 @@
+---
+format:
+  md:
+    prefer_html: true
+default-image-extension: ""
+---
diff --git a/altdoc/preamble_vignettes_rmd.yml b/altdoc/preamble_vignettes_rmd.yml
@@ -0,0 +1,4 @@
+---
+always_allow_html: yes
+---
+
diff --git a/man/figures/example1-1.png b/man/figures/example1-1.png
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png
diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png
diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png
diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png
diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png
diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png
diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png
diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png
diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -1,4 +1,2 @@
 *.html
 *.R
-web_only/*.png
-web_only/*.svg
diff --git a/vignettes/web_only/cheat_sheet.Rmd → vignettes/cheat_sheet.Rmd b/vignettes/web_only/cheat_sheet.Rmd → vignettes/cheat_sheet.Rmd
@@ -1,6 +1,6 @@
 ---
 title: "Cheat Sheet"
-author: "Ronan Ysebaert"
+author: "Ronan Ysebaert & Timothée Giraud"
 date: "`r Sys.Date()`"
 output: rmarkdown::html_vignette
 vignette: >
@@ -10,8 +10,7 @@ vignette: >
 ---
 
 
-```{r, echo=FALSE, out.width="100%"}
-knitr::include_graphics("img/mapsf_cheatsheet.png")
-```
+![](fig/mapsf_cheatsheet.png)
+
 
 [Download PDF version](https://raw.githubusercontent.com/riatelab/mapsf/master/vignettes/web_only/img/mapsf_cheatsheet.pdf)
diff --git a/vignettes/web_only/img/mapsf_cheatsheet.pdf → vignettes/fig/mapsf_cheatsheet.pdf b/vignettes/web_only/img/mapsf_cheatsheet.pdf → vignettes/fig/mapsf_cheatsheet.pdf
diff --git a/vignettes/web_only/img/mapsf_cheatsheet.png → vignettes/fig/mapsf_cheatsheet.png b/vignettes/web_only/img/mapsf_cheatsheet.png → vignettes/fig/mapsf_cheatsheet.png
diff --git a/vignettes/web_only/img/mapsf_cheatsheet.svg → vignettes/fig/mapsf_cheatsheet.svg b/vignettes/web_only/img/mapsf_cheatsheet.svg → vignettes/fig/mapsf_cheatsheet.svg
diff --git a/vignettes/fig/wo_export_fixed_height_centered.png b/vignettes/fig/wo_export_fixed_height_centered.png
diff --git a/vignettes/fig/wo_export_fixed_width.png b/vignettes/fig/wo_export_fixed_width.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,3 +24,4 @@ docs
		/Meta/

		note.md
		altdoc/freeze.rds