This new ap-ls.org website is built in RStudio using Quarto. The content for the site is stored on the AP-LS Google Drive and on GitHub. The site is published using Netlify. The root directory that contains the published site is docs
.
The main content for the site is stored in the following files and directories:
_quarto.yml
controls site-wide parameters and defines navbar/sidebar/footer content_variables.yml
controls site-wide variables that can be inserted using shortcodesapls_functions.R
in_site
runs ther
functions that are used to build aspects of the site including the image carousel. Do not change this.index.qmd
is the home pageabout
,conferences
,publications
,resources
, andmembership
are folders that contain those respective pages for the site and other listing pages- The main page for each section is saved as
index.qmd
- For the pages that include listings, the
index.qmd
file in each folder specifies what is included
- The main page for each section is saved as
404.qmd
is the 404 page for the sitestyles.css
andtheme.scss
in theassets
directory are used for additional CSS and SASS styling for the site's appearance, such as fonts and colorsindex.css
inconferences/
has additional styling for the conference page
Freeze
The pages are frozen so that the documents are not individually re-rendered during a global project render.
The site is built using Quarto which provides an extensive guide and reference materials.
The project uses renv
to ensure that all edits to the website use the same package versions. To edit the site, you need to:
- Clone the
emarshall/apls-org
repository - Start a new R session in your new project directory and initialize
renv
. If you are not sure if you have therenv
package installed you can run the following:
# Install the 'renv' package if not already installed
if (!requireNamespace("renv", quietly = TRUE)) {
install.packages("renv")
}
# Initialize 'renv' in your project directory
renv::init()
# Restore the project's packages (this installs packages from the 'renv.lock' file)
renv::restore()
- To preview the site from your terminal use:
quarto preview mlr-org
Each page has its own .qmd
file in the apls-org/
directory. However, many pages (i.e., job postings, image carousel, etc.) need to be updated by making changes to the accompanying .yml
file. See below for instructions editing this type of content:
The content on the home is determined by the apls-org/index.qmd
file. It is located in the main apls-org/
directory. The images for the carousel that appears at the top of the page are stored in apls-org/images/
. The items in the carousel are determined by the content in the apls-org/carousel.yml
file. To add (or remove) an item you need to:
- Save the image file in
apls-org/images/
. - Create a new entry in the
carousel.yml
file, with the following information:
caption
: Insert text to appear under imageimage
: path to image filelink
: url to open when image is clicked (if no link is avialable, use "")
Example:
- caption: "2024 AP-LS Call for Conference Proposals!"
image: "images/2024_call_for_proposals.jpeg"
link: "https://ap-ls.org/conferences/"
- Render new
apls-org/index.qmd
file
The job postings content is located in the resources/job-postings/
directory. The index.qmd
file sets the content for the job-postings page. The items that appear on the page are determined by the academic-jobs.yml
and professional-jobs.yml
files. To add or remove an item you need to:
- Locate the correct
yml
file for the posting (ie., academic vs professional) - Create a new entry in the
academic-jobs.yml
orprofessional-jobs.yml
file, with the following information:
title
: name of position availabledate
: Current date (YYYY-MM-DD)organization
: Name of institution or businesslocation
: Where position is locatedurl
: External link to job posting
Example:
- title: Assistant Professor of Psychology
date: 2023-08-02
organization: University of Nebraska, Department of Psychology
location: Lincoln, Nebraska
url: https://unl.example.com/
- Render new
apls-org/resources/job-postings/index.qmd
file
- Proofread content pages
- Create r package to store functions
- Newsletter archives - index and format listings (include pds)
- TTC Education and Teaching materials
- How to add a new post/page write up