From 5fba9648cf542de70ff21818f1444c66eb719612 Mon Sep 17 00:00:00 2001 From: Naomi Rosenkranz Date: Thu, 19 Jan 2023 15:37:30 -0500 Subject: [PATCH 1/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9ad4201..9811189 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ +[![DOI](https://zenodo.org/badge/574679318.svg)](https://zenodo.org/badge/latestdoi/574679318) + # editioncrafter-project Planning repo for EditionCrafter publication tool From 14f9b9c55dad281e3ace137bc70cc2a84d36f64a Mon Sep 17 00:00:00 2001 From: Naomi Rosenkranz Date: Fri, 22 Sep 2023 13:01:09 -0400 Subject: [PATCH 2/5] Update README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d57e3da..403f5a1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ [![DOI](https://zenodo.org/badge/574679318.svg)](https://zenodo.org/badge/latestdoi/574679318) # editioncrafter-project -Planning repo for EditionCrafter publication tool - \ No newline at end of file +This is the repository for websites containing EditionCrafter editions. It contains the stub markdown pages and navigation for the websites. + +Hugo website template +This can now be customized for content +Under “Folios,” there is the rendered TEI file of the manuscript +Took output of editioncrafter-cli and dropped into the dedicated directory of editioncrafter-project From 2b0cda82a4a668dac1d903237eb1b14514ca8138 Mon Sep 17 00:00:00 2001 From: Naomi Rosenkranz Date: Fri, 22 Sep 2023 13:01:33 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 403f5a1..fc30276 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # editioncrafter-project This is the repository for websites containing EditionCrafter editions. It contains the stub markdown pages and navigation for the websites. -Hugo website template -This can now be customized for content -Under “Folios,” there is the rendered TEI file of the manuscript -Took output of editioncrafter-cli and dropped into the dedicated directory of editioncrafter-project +- Hugo website template +- This can now be customized for content +- Under “Folios,” there is the rendered TEI file of the manuscript +- Took output of editioncrafter-cli and dropped into the dedicated directory of editioncrafter-project From c1651f7d20550e59b5350e366d217e542e3fbc83 Mon Sep 17 00:00:00 2001 From: Naomi Rosenkranz Date: Fri, 22 Sep 2023 14:05:53 -0400 Subject: [PATCH 4/5] Update folios.md --- content/folios.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/folios.md b/content/folios.md index 453a1f2..5058279 100644 --- a/content/folios.md +++ b/content/folios.md @@ -10,4 +10,4 @@ transcriptionTypes: tcn: 'Normalized (FR)' tl: 'Translation (EN)' weight: 30 ---- \ No newline at end of file +--- From 55570e90d3268180369a2b1b35a92d059e38b92d Mon Sep 17 00:00:00 2001 From: Rebecca Black Date: Fri, 23 Feb 2024 14:22:43 -0500 Subject: [PATCH 5/5] Update README.md Updated README with basic instructions for deploying a fork to github pages. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index fc30276..9024f42 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,11 @@ This is the repository for websites containing EditionCrafter editions. It conta - This can now be customized for content - Under “Folios,” there is the rendered TEI file of the manuscript - Took output of editioncrafter-cli and dropped into the dedicated directory of editioncrafter-project + +# To create a website from this repository + +- Fork this repository (you only need to copy the `main` branch) +- In your fork, update the `baseURL` in `config/production/config.toml` to reflect your organization and new repository name +- In your fork, update the markdown files in the `content` folder with your content. In particular make sure to update the information in `folios.md` +- If you only copied the main branch, at this point you should create a new branch called `dev`. This will have the effect of triggering a workflow that creates the files you'll need to deploy your site to GitHub Pages; those files live in a `gh-pages` branch, which will be created by the workflow +- Once the workflow is run and the `gh-pages` branch exists, go to the settings tab for your repo and select "Pages" from the menu on the left. Enable GitHub pages and set your site to deploy from a branch, and then select the `gh-pages` branch (and `/root`) folder.