adds intro, theme changes, readme updated

qtalr · Mar 10, 2024 · 00f7524 · 00f7524
1 parent bb393b6
commit 00f7524
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 3 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -10,9 +10,12 @@ Description: Support package for the textbook "An Introduction to
 Date: 2024-03-10
 License: GPL (>= 3)
 Suggests:
+    knitr,
+    rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1
 URL: https://qtalr.github.io/qtkit/
+VignetteBuilder: knitr
diff --git a/README.Rmd b/README.Rmd
@@ -13,11 +13,12 @@ knitr::opts_chunk$set(
 )
 ```
 
-# Quantitative Text Kit (`qtkit`)
+# Quantitative Text Kit
 
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![CRAN status](https://www.r-pkg.org/badges/version/qtkit)](https://CRAN.R-project.org/package=qtkit)
+[![Update universe](https://github.com/r-universe/francojc/actions/workflows/sync.yml/badge.svg)](https://github.com/r-universe/francojc/actions/workflows/sync.yml)
 <!-- badges: end -->
 
 The goal of `qtkit` is to provide a support package for the textbook ["An Introduction to Quantitative Text Analysis for Linguistics: Reproducible Research using R"](https://qtalr.github.io/book). It contains functions for collecting and manipulating data and datasets, documentation, and other assorted tasks associated with quantative text analysis in R.

diff --git a/README.md b/README.md
@@ -2,14 +2,16 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# Quantitative Text Kit (`qtkit`)
+# Quantitative Text Kit
 
 <!-- badges: start -->
 
 [![Lifecycle:
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![CRAN
 status](https://www.r-pkg.org/badges/version/qtkit.png)](https://CRAN.R-project.org/package=qtkit)
+[![Update
+universe](https://github.com/r-universe/francojc/actions/workflows/sync.yml/badge.svg)](https://github.com/r-universe/francojc/actions/workflows/sync.yml)
 <!-- badges: end -->
 
 The goal of `qtkit` is to provide a support package for the textbook

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -1,9 +1,12 @@
 url: https://qtalr.github.io/qtkit/
 template:
   bootstrap: 5
-  bootswatch: materia
+  bootswatch: flatly
+  bslib:
+    pkgdown-nav-height: 75px
 
 navbar:
+  bg: secondary
   structure:
     left:
       - intro

diff --git a/vignettes/.gitignore b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/qtkit.Rmd b/vignettes/qtkit.Rmd
@@ -0,0 +1,19 @@
+---
+title: "qtkit"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{qtkit}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(qtkit)
+```