docute

vincentarelbundock · Nov 13, 2023 · 203af43 · 203af43
1 parent a07b8d5
commit 203af43
Show file tree

Hide file tree

Showing 7 changed files with 130 additions and 169 deletions.
diff --git a/altdoc/docsify.html b/altdoc/docsify.html
diff --git a/altdoc/docsify.md b/altdoc/docsify.md
diff --git a/altdoc/docute.html b/altdoc/docute.html
@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <title>$ALTDOC_PACKAGE_NAME</title>
+    <link rel="stylesheet" href="https://unpkg.com/docute@4/dist/docute.css">
+    <!-- Reduce space between sections and subsections -->
+     <style>
+      .page-content h2 {
+        margin-top: 2em;
+      }
+      .page-content.has-page-title>h2:first-child {
+        margin-top: 2em;
+      }
+      .page-content h3 {
+        margin-top: 2em;
+      }
+      .page-content.has-page-title>h3:first-child {
+        margin-top: 2em;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="docute"></div>
+    <script src="https://unpkg.com/docute@4/dist/docute.js"></script>
+    <script>
+      new Docute({
+        target: '#docute',
+        title: '$ALTDOC_PACKAGE_NAME',
+        highlight: ['r'],
+        darkThemeToggler: true,
+        nav: [
+					{title: 'Home', link: '/' },
+					{title: 'GitHub', link: '$ALTDOC_PACKAGE_URL_GITHUB' },
+				],
+				sidebar: [
+					{title: 'Home', link: '/'},
+					{title: 'Changelog', link: '$ALTDOC_NEWS'},
+          $ALTDOC_VIGNETTE_BLOCK
+          $ALTDOC_MAN_BLOCK
+					{title: 'Code of Conduct', link: '$ALTDOC_CODE_OF_CONDUCT'},
+					{title: 'License', link: '$ALTDOC_LICENSE'}
+				],
+        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>"
+      })
+    </script>
+  </body>
+</html>
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
diff --git a/docs/articles/countrycode.md b/docs/articles/countrycode.md
@@ -65,22 +65,22 @@ df1
 ```
 
       cowcodes var1
-    1      ALG  255
-    2      ALB  329
-    3      UKG  256
-    4      CAN  289
-    5      USA   72
+    1      ALG  185
+    2      ALB  375
+    3      UKG  382
+    4      CAN  313
+    5      USA  149
 
 ``` r
 df2
 ```
 
       isocodes var2
-    1       12  304
-    2        8  465
-    3      826  270
-    4      124   59
-    5      840   84
+    1       12  156
+    2        8  485
+    3      826  374
+    4      124  208
+    5      840  313
 
 Create a common variable with the iso3c code in each data frame, merge
 the data, and create a country identifier:
@@ -94,11 +94,11 @@ df3
 ```
 
       iso3c cowcodes var1 isocodes var2        country
-    1   ALB      ALB  329        8  465        Albania
-    2   CAN      CAN  289      124   59         Canada
-    3   DZA      ALG  255       12  304        Algeria
-    4   GBR      UKG  256      826  270 United Kingdom
-    5   USA      USA   72      840   84  United States
+    1   ALB      ALB  375        8  485        Albania
+    2   CAN      CAN  313      124  208         Canada
+    3   DZA      ALG  185       12  156        Algeria
+    4   GBR      UKG  382      826  374 United Kingdom
+    5   USA      USA  149      840  313  United States
 
 ## Flags
 

diff --git a/docs/docsify.html b/docs/docsify.html
diff --git a/docs/index.html b/docs/index.html
@@ -1,44 +1,69 @@
-<!-- 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">
-  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
-</head>
-<body>
-  <div id="app"></div>
-  <script>
-    window.$docsify = {
-      name: 'countrycode',
-      loadSidebar: true,
-      subMaxLevel: 2,
-      search: {
-        placeholder: 'Search',
-        depth: 3,
-      },
-      auto2top: true,
-      copyCode: {
-        buttonText : 'Copy',
-        errorText  : 'Error',
-        successText: 'Copied'
-      },
-      plugins: [
-        function(hook) {
-          var footer = ["<a href='https://vincentarelbundock.github.io/countrycode/'> <code> countrycode </code> v. 1.5.0.9001 </a> | Documentation made with <a href='https://altdoc.etiennebacher.com/'> <code> altdoc </code> v. 0.2.2.9004</a>"].join('');
-
-          hook.afterEach(function(html) {
-            return html + footer;
-          });
-        }
-      ]
-    }
-  </script>
-  <script src="//cdn.jsdelivr.net/npm/docsify@4"></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>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <title>countrycode</title>
+    <link rel="stylesheet" href="https://unpkg.com/docute@4/dist/docute.css">
+    <!-- Reduce space between sections and subsections -->
+     <style>
+      .page-content h2 {
+        margin-top: 2em;
+      }
+      .page-content.has-page-title>h2:first-child {
+        margin-top: 2em;
+      }
+      .page-content h3 {
+        margin-top: 2em;
+      }
+      .page-content.has-page-title>h3:first-child {
+        margin-top: 2em;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="docute"></div>
+    <script src="https://unpkg.com/docute@4/dist/docute.js"></script>
+    <script>
+      new Docute({
+        target: '#docute',
+        title: 'countrycode',
+        highlight: ['r'],
+        darkThemeToggler: true,
+        nav: [
+					{title: 'Home', link: '/' },
+				],
+				sidebar: [
+					{title: 'Home', link: '/'},
+					{title: 'Changelog', link: '/NEWS'},
+                    {
+           title: 'Articles',
+           children:
+             [
+              {title: 'Contributions', link: '/articles/contributions.md'},
+              {title: 'Country codes', link: '/articles/countrycode.md'},
+              {title: 'Country names', link: '/articles/countryname.md'},
+              {title: 'Custom conversion functions', link: '/articles/custom.md'},
+             ]
+          },
+                    {
+           title: 'Reference',
+           children:
+             [
+              {title: 'cldr_examples', link: '/man/cldr_examples.md'},
+              {title: 'codelist_panel', link: '/man/codelist_panel.md'},
+              {title: 'codelist', link: '/man/codelist.md'},
+              {title: 'countrycode-package', link: '/man/countrycode-package.md'},
+              {title: 'countrycode', link: '/man/countrycode.md'},
+              {title: 'countryname_dict', link: '/man/countryname_dict.md'},
+              {title: 'countryname', link: '/man/countryname.md'},
+              {title: 'get_dictionary', link: '/man/get_dictionary.md'},
+              {title: 'guess_field', link: '/man/guess_field.md'},
+             ]
+          },
+				],
+        footer: "<a href='https://vincentarelbundock.github.io/countrycode/'> <code> countrycode </code> v. 1.5.0.9001 </a> | Documentation made with <a href='https://altdoc.etiennebacher.com/'> <code> altdoc </code> v. 0.2.2.9004</a>"
+      })
+    </script>
+  </body>
 </html>