Skip to content

Commit

Permalink
Better repo contents
Browse files Browse the repository at this point in the history
  • Loading branch information
djvill committed Aug 12, 2023
1 parent 1f74b8a commit 240b018
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This repo is still very much a work in progress.
However, I anticipate it'll contain info for not only end-users, but also transcribers and corpus maintainers.


## GitHub Pages
## GitHub Pages/Jekyll

The public-facing pages are built and deployed to https://djvill.github.io/APLS/ using GitHub Pages.
The page source is built from the `main` branch's root directory, using the ["deploy from a branch"](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch) workflow;
Expand All @@ -30,8 +30,17 @@ I decided this limitation was worth not clogging up the repository with a ton of

## Repo contents

- `_includes/`: For [GitHub Pages](#github-pages)
- `_layouts/`: For [GitHub Pages](#github-pages)
- `_includes/`: Content stubs (see [Jekyll doc](https://jekyllrb.com/docs/includes/))
- `_layouts/`: Page layouts (see [Jekyll doc](https://jekyllrb.com/docs/layouts/))
- `_sass/`: Sass partials (see [Jekyll doc](https://jekyllrb.com/docs/configuration/sass/))
- `assets/`: Site assets (CSS, JavaScript, image files)
- `doc/`: Documentation---the meat of the public-facing website
- `files/`: Files relevant to the corpus
- `custom-dictionary/`: Custom dictionary entries
- `layer-scripts/`: Script files for APLS layers annotated by Python layer manager
- `./` (this folder):
- `.gitignore`: For [Git version control](https://git-scm.com/docs/gitignore)
- `_config.yml`: Site configuration file (see [Jekyll doc](https://jekyllrb.com/docs/configuration/))
- `LICENSE.md`: Markdown conversion of [legal code for CC BY-NC-SA 4.0 license](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode)
- `README.md`: What you're reading right now!
- `SPLASH.md`: APLS homepage (aka splash page), injected via `<iframe>` into https://apls.pitt.edu/

0 comments on commit 240b018

Please sign in to comment.