Skip to content

Commit 6f426f4

Browse files
committed
init
0 parents  commit 6f426f4

33 files changed

Lines changed: 1508 additions & 0 deletions

.github/workflows/docs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: read
8+
pages: write
9+
id-token: write
10+
jobs:
11+
deploy:
12+
environment:
13+
name: github-pages
14+
url: ${{ steps.deployment.outputs.page_url }}
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/configure-pages@v6
18+
- uses: actions/checkout@v6
19+
- uses: actions/setup-python@v6
20+
with:
21+
python-version: 3.x
22+
- run: pip install zensical
23+
- run: zensical build --clean
24+
- uses: actions/upload-pages-artifact@v5
25+
with:
26+
path: site
27+
- uses: actions/deploy-pages@v5
28+
id: deployment

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
site/
2+
.DS_Store

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mmcl.library.yorku.ca

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# dsi.library.yorku.ca
2+
3+
This site is built with [Zensical](https://zensical.org). The sections below walk through the most common update tasks.
4+
5+
## How to Update
6+
7+
### Adding New Pages or Editing Existing Pages
8+
9+
1. Create a [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) or a [branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) of this repository.
10+
2. Work locally on your own machine, or on [GitHub](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) editing existing or creating new [Markdown](https://zensical.org/docs/authoring/markdown/) files.
11+
3. [Commit](https://docs.github.com/en/pull-requests/committing-changes-to-your-project) your changes. [Write a good commit message](https://hslguides.med.nyu.edu/c.php?g=1429737&p=10610735). Think of this the way you would document changes or maintain a revision history for an institutional document.
12+
4. Open a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to propose your changes for review.
13+
14+
> **New to Git or GitHub?** The Software Carpentry [Version Control with Git](https://swcarpentry.github.io/git-novice/) course is a solid starting point, including for collaborative workflows.
15+
16+
### Changing Site Structure or Navigation
17+
18+
Navigation is configured in [`zensical.toml`](https://github.com/yorkulibraries/dsi.library.yorku.ca/blob/main/zensical.toml#L40-L78). The nested array in that file controls how the site navigation is organized, and it corresponds directly to how content is structured in the [`docs`](https://github.com/yorkulibraries/dsi.library.yorku.ca/tree/main/docs) folder. Changes to navigation and changes to the `docs` folder structure go hand in hand.
19+
20+
### Working with Images
21+
22+
Store images in the [`docs/images`](https://github.com/yorkulibraries/dsi.library.yorku.ca/tree/main/docs/images) folder. To link to or embed an image anywhere on the site, use the path: `/images/filename.ext`
23+
24+
### ⚠️ Caution: Files to Leave Alone
25+
26+
Unless you have a specific reason and are confident in what you're doing, do not edit or remove the following:
27+
28+
- `.github/workflows`
29+
- `CNAME`
30+
- `docs/stylesheets/extra.css`

docs/course-integration/arth-3999.md

Whitespace-only changes.

0 commit comments

Comments
 (0)