Skip to content

Commit d8a3335

Browse files
committed
add pkgdown site
1 parent f6bdf62 commit d8a3335

File tree

7 files changed

+59
-3
lines changed

7 files changed

+59
-3
lines changed

.Rbuildignore

+3
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@
55
^doc$
66
^Meta$
77
^\.github$
8+
^_pkgdown\.yml$
9+
^docs$
10+
^pkgdown$

.github/workflows/pkgdown.yaml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
release:
9+
types: [published]
10+
workflow_dispatch:
11+
12+
name: pkgdown
13+
14+
jobs:
15+
pkgdown:
16+
runs-on: ubuntu-latest
17+
# Only restrict concurrency for non-PR jobs
18+
concurrency:
19+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
20+
env:
21+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
22+
permissions:
23+
contents: write
24+
steps:
25+
- uses: actions/checkout@v3
26+
27+
- uses: r-lib/actions/setup-pandoc@v2
28+
29+
- uses: r-lib/actions/setup-r@v2
30+
with:
31+
use-public-rspm: true
32+
33+
- uses: r-lib/actions/setup-r-dependencies@v2
34+
with:
35+
extra-packages: any::pkgdown, local::.
36+
needs: website
37+
38+
- name: Build site
39+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
40+
shell: Rscript {0}
41+
42+
- name: Deploy to GitHub pages 🚀
43+
if: github.event_name != 'pull_request'
44+
uses: JamesIves/[email protected]
45+
with:
46+
clean: false
47+
branch: gh-pages
48+
folder: docs

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ inst/doc
88
/doc/
99
/Meta/
1010
progress.r
11+
docs

README.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ knitr::opts_chunk$set(
1313
)
1414
```
1515

16-
# `rollama`
16+
# `rollama` <img src="man/figures/logo.png" align="right" height="138" alt="rollama-logo" />
1717

1818
<!-- badges: start -->
1919
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
20-
[![say-thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/JBGruber)
2120
[![R-CMD-check](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml)
21+
[![say-thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/JBGruber)
2222
<!-- badges: end -->
2323

2424
The goal of `rollama` is to wrap the Ollama API, which allows you to run different LLMs locally and create an experience similar to ChatGPT/OpenAI's API.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<!-- README.md is generated from README.Rmd. Please edit that file -->
33

4-
# `rollama`
4+
# `rollama` <img src="man/figures/logo.png" align="right" height="138" alt="rollama-logo" />
55

66
<!-- badges: start -->
77
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

_pkgdown.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
url: https://jbgruber.github.io/rollama/
2+
template:
3+
bootstrap: 5
4+

man/figures/logo.png

57.4 KB
Loading

0 commit comments

Comments
 (0)