Skip to content

Commit

Permalink
Deploying to gh-pages from @ e178888 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
maelle committed Dec 17, 2024
1 parent 5557a12 commit 2392e90
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions publish/set-up.html
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ <h1 class="title"><span class="chapter-number">10</span>&nbsp; <span class="chap

<section id="basic-steps" class="level2" data-number="10.1">
<h2 data-number="10.1" class="anchored" data-anchor-id="basic-steps"><span class="header-section-number">10.1</span> Basic steps</h2>
<p>Creating a universe for your R packages can be done in a few steps described below. The further sections on this page give more details on each step.</p>
<p>Setting up a universe for your R packages involves just a few steps, outlined below. Additional details for each step are provided in the sections that follow.</p>
<ol type="1">
<li><strong>Create a Git repository named (all lowercase) <code>&lt;your-username&gt;.r-universe.dev</code> on your GitHub account</strong>, containing a <code>packages.json</code> file which lists the Git repositories with R packages to include.
<ul>
Expand All @@ -342,14 +342,14 @@ <h2 data-number="10.1" class="anchored" data-anchor-id="basic-steps"><span class
</section>
<section id="subdomain" class="level2" data-number="10.2">
<h2 data-number="10.2" class="anchored" data-anchor-id="subdomain"><span class="header-section-number">10.2</span> Creating your personal R-universe subdomain</h2>
<p>In R-universe, every user has a private subdomain, where you control the content, and which does not interfere with other users. The subdomains are tied to the GitHub account or organization with that name.</p>
<p>Each user gets a private subdomain on R-universe, where you control the content independently. Subdomains are tied to GitHub accounts or organizations with the same name.</p>
<section id="case-sensitivity" class="level3" data-number="10.2.1">
<h3 data-number="10.2.1" class="anchored" data-anchor-id="case-sensitivity"><span class="header-section-number">10.2.1</span> Case-sensitivity</h3>
<p>Domain names are by definition case-insensitive and lowercased.</p>
</section>
<section id="how-much-github-is-compulsory" class="level3" data-number="10.2.2">
<h3 data-number="10.2.2" class="anchored" data-anchor-id="how-much-github-is-compulsory"><span class="header-section-number">10.2.2</span> How much GitHub is compulsory?</h3>
<p>In order to start a universe you need a GitHub account as that is where the repository with your packages’ listing has to be hosted. However <strong>the R packages themselves do not necessarily need to exist under that same account</strong>. They <strong>don’t even need to be on GitHub</strong>: they may be hosted on <strong>any public Git server</strong>. If your R packages are hosted on another Git service, such as Gitlab, or a university Git server, you can simply use a GitHub account only for publishing a <code>packages.json</code> registry for that username, without having to buy into the full GitHub platform.</p>
<p>You need a GitHub account to host the repository for your <code>packages.json</code> registry. However, <strong>the R packages themselves do not need to be under the same account or even on GitHub</strong>. They can be hosted on <strong>any public Git server</strong>, such as GitLab or a university Git server. A GitHub account is only required for publishing the <code>packages.json</code> registry.</p>
</section>
</section>
<section id="populating-the-packages.json-registry-file" class="level2" data-number="10.3">
Expand Down Expand Up @@ -438,7 +438,7 @@ <h2 data-number="10.6" class="anchored" data-anchor-id="document-install"><span
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a><span class="co"># Install some packages</span></span>
<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">'tinkr'</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>To help package users, you can consider copying these instructions to your package README.md files. And of course you can add an R-universe badge to the package README as well.</p>
<p>Copy these instructions to your package <code>README.md</code> files to assist users. You can also add an R-universe badge to indicate the deployed version:</p>
<p>The badge API is simply <code>/badges/&lt;package&gt;</code> which will yield an SVG image that can directly be embedded into your markdown files, showing the deployed version for the given package:</p>
<div class="sourceCode" id="cb5"><pre class="sourceCode md code-with-copy"><code class="sourceCode markdown"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="al">![r-universe](https://r-lib.r-universe.dev/badges/cpp11)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>For example this would produce the following badge: <img style="margin-bottom:3px;" src="https://r-lib.r-universe.dev/badges/cpp11"></p>
Expand Down
6 changes: 3 additions & 3 deletions search.json
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@
"href": "publish/set-up.html",
"title": "10  Set up your own universe",
"section": "",
"text": "10.1 Basic steps\nCreating a universe for your R packages can be done in a few steps described below. The further sections on this page give more details on each step.",
"text": "10.1 Basic steps\nSetting up a universe for your R packages involves just a few steps, outlined below. Additional details for each step are provided in the sections that follow.",
"crumbs": [
"Publish",
"<span class='chapter-number'>10</span>  <span class='chapter-title'>Set up your own universe</span>"
Expand All @@ -399,7 +399,7 @@
"href": "publish/set-up.html#subdomain",
"title": "10  Set up your own universe",
"section": "10.2 Creating your personal R-universe subdomain",
"text": "10.2 Creating your personal R-universe subdomain\nIn R-universe, every user has a private subdomain, where you control the content, and which does not interfere with other users. The subdomains are tied to the GitHub account or organization with that name.\n\n10.2.1 Case-sensitivity\nDomain names are by definition case-insensitive and lowercased.\n\n\n10.2.2 How much GitHub is compulsory?\nIn order to start a universe you need a GitHub account as that is where the repository with your packages’ listing has to be hosted. However the R packages themselves do not necessarily need to exist under that same account. They don’t even need to be on GitHub: they may be hosted on any public Git server. If your R packages are hosted on another Git service, such as Gitlab, or a university Git server, you can simply use a GitHub account only for publishing a packages.json registry for that username, without having to buy into the full GitHub platform.",
"text": "10.2 Creating your personal R-universe subdomain\nEach user gets a private subdomain on R-universe, where you control the content independently. Subdomains are tied to GitHub accounts or organizations with the same name.\n\n10.2.1 Case-sensitivity\nDomain names are by definition case-insensitive and lowercased.\n\n\n10.2.2 How much GitHub is compulsory?\nYou need a GitHub account to host the repository for your packages.json registry. However, the R packages themselves do not need to be under the same account or even on GitHub. They can be hosted on any public Git server, such as GitLab or a university Git server. A GitHub account is only required for publishing the packages.json registry.",
"crumbs": [
"Publish",
"<span class='chapter-number'>10</span>  <span class='chapter-title'>Set up your own universe</span>"
Expand Down Expand Up @@ -443,7 +443,7 @@
"href": "publish/set-up.html#document-install",
"title": "10  Set up your own universe",
"section": "10.6 Adding badges and user instructions",
"text": "10.6 Adding badges and user instructions\nOnce your packages have appeared on the dashboard, try installing them in R using the instructions from the dashboard page, for example:\n# Enable this universe\noptions(repos = c(\n maelle = 'https://maelle.r-universe.dev',\n CRAN = 'https://cloud.r-project.org'))\n\n# Install some packages\ninstall.packages('tinkr')\nTo help package users, you can consider copying these instructions to your package README.md files. And of course you can add an R-universe badge to the package README as well.\nThe badge API is simply /badges/&lt;package&gt; which will yield an SVG image that can directly be embedded into your markdown files, showing the deployed version for the given package:\n![r-universe](https://r-lib.r-universe.dev/badges/cpp11)\nFor example this would produce the following badge:",
"text": "10.6 Adding badges and user instructions\nOnce your packages have appeared on the dashboard, try installing them in R using the instructions from the dashboard page, for example:\n# Enable this universe\noptions(repos = c(\n maelle = 'https://maelle.r-universe.dev',\n CRAN = 'https://cloud.r-project.org'))\n\n# Install some packages\ninstall.packages('tinkr')\nCopy these instructions to your package README.md files to assist users. You can also add an R-universe badge to indicate the deployed version:\nThe badge API is simply /badges/&lt;package&gt; which will yield an SVG image that can directly be embedded into your markdown files, showing the deployed version for the given package:\n![r-universe](https://r-lib.r-universe.dev/badges/cpp11)\nFor example this would produce the following badge:",
"crumbs": [
"Publish",
"<span class='chapter-number'>10</span>  <span class='chapter-title'>Set up your own universe</span>"
Expand Down
30 changes: 15 additions & 15 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,62 +2,62 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.r-universe.dev/index.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/browse/get-started.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/browse/search.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/browse/universes.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/browse/packages.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/browse/api.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/browse/rss-feeds.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/install/binaries.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/install/reproducibility.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/publish/get-started.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/publish/set-up.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/publish/metadata.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/publish/troubleshoot-build.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/publish/terms.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
<url>
<loc>https://docs.r-universe.dev/publish/other-networks.html</loc>
<lastmod>2024-12-17T11:09:48.000Z</lastmod>
<lastmod>2024-12-17T11:10:17.000Z</lastmod>
</url>
</urlset>

0 comments on commit 2392e90

Please sign in to comment.