Skip to content

Commit 2321b6d

Browse files
committed
Deploying to gh-pages from @ d16381e 🚀
1 parent 5e555c0 commit 2321b6d

30 files changed

Lines changed: 516 additions & 149 deletions

404.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

404.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Content not found. Please use links in the navbar.
2+
3+
# Page not found (404)

LICENSE-text.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE-text.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# License
2+
3+
YEAR: 2025
4+
COPYRIGHT HOLDER: Visruth Srimath Kandali

LICENSE.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# NA
2+
3+
Copyright 2025 Visruth Srimath Kandali
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are
7+
met:
8+
9+
1. Redistributions of source code must retain the above copyright
10+
notice, this list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright
13+
notice, this list of conditions and the following disclaimer in the
14+
documentation and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS
21+
IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22+
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23+
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
26+
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28+
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

articles/GitHub Action.html

Lines changed: 32 additions & 34 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

articles/GitHub Action.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# GitHub Action
2+
3+
Here is a GitHub Action which can be used with the theme to
4+
automatically build the site.
5+
6+
``` yaml
7+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
8+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
9+
on:
10+
# build dev site on merged pushes
11+
push:
12+
branches: [main, master]
13+
# build full site on releases
14+
release:
15+
types: [published]
16+
workflow_dispatch:
17+
18+
name: pkgdown.yaml
19+
20+
jobs:
21+
pkgdown:
22+
runs-on: ubuntu-latest
23+
# Only restrict concurrency for non-PR jobs
24+
concurrency:
25+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
26+
cancel-in-progress: true
27+
env:
28+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
29+
NOT_CRAN: true
30+
permissions:
31+
contents: write
32+
steps:
33+
- uses: actions/checkout@v6
34+
35+
- uses: r-lib/actions/setup-pandoc@v2
36+
37+
- uses: r-lib/actions/setup-r@v2
38+
with:
39+
use-public-rspm: true
40+
41+
- uses: r-lib/actions/setup-r-dependencies@v2
42+
with:
43+
extra-packages: any::pkgdown, local::., stan-dev/pkgdown-config
44+
45+
- name: Build site
46+
run: |
47+
pkgdown::build_site_github_pages(
48+
lazy = FALSE, # change to TRUE if runner times out.
49+
run_dont_run = TRUE,
50+
new_process = TRUE
51+
)
52+
shell: Rscript {0}
53+
54+
- name: Deploy to GitHub pages 🚀
55+
uses: JamesIves/github-pages-deploy-action@v4
56+
with:
57+
clean: false
58+
branch: gh-pages
59+
folder: docs
60+
```

articles/Quirks.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

articles/Quirks.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Quirks
2+
3+
Due to how the theme is written, there are some thing you should note.
4+
5+
## Templates
6+
7+
This theme uses partials to override the default templates for the
8+
navbar and for `head`. These are both pinned at a [specific
9+
commit](https://github.com/r-lib/pkgdown/tree/fe04924b3df129bea60ac871614b01d87bcae147).
10+
If you notice that the theme is behind upstream, please open an issue.
11+
12+
### before-title
13+
14+
Since the theme overrides the navbar partial to insert the logo,
15+
anything HTML put in `before-title` will appear before the logo.
16+
17+
``` yaml
18+
template:
19+
includes:
20+
# before_title_AND_LOGO
21+
before_title: |
22+
My_cool_html
23+
```
24+
25+
I left the functionality in so that the website wouldn’t fail silently
26+
and eat your input, but I hazard that you won’t want to put anything
27+
before the logo. If you want to put things in `before_title` you should
28+
copy my `navbar.HTML` into your package’s pkgdown configuration and edit
29+
it, putting HTML where it says
30+
`{#includes}{{{before_navbar}}}{{/includes}}`.
31+
32+
## Logs Say Image Missing
33+
34+
This template copies over the Stan hex logo to root and references that
35+
manually in the templates, which `pkgdown` doens’t like. As such, you’ll
36+
get errors like
37+
38+
Missing images in .github/CONTRIBUTING.md: logo.png
39+
ℹ pkgdown can only use images in man/figures and vignettes
40+
41+
If you actually navigate to that page the logo will be there. I may
42+
fix/change this by referencing man/figures/logo (which is also copied
43+
over).

0 commit comments

Comments
 (0)