Skip to content

GH-Pages and adding examples #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from

Conversation

jtlandis
Copy link
Collaborator

Hello everyone,

Here are the changes made to the repository:

  • added "docs" to .gitignore
  • removed tracking of docs folder from the git tree.
  • using a github action shamelessly copied from Hadley's quarto book github action. This github action will run quarto render on the repo whenever the main branch gets a merge or PR. On merges to main branch, the built documents from quarto render are cached and published to the gh-pages branch of the repo (see example).
    • To have this PR work upon merge, someone should adjust the settings such that pages are published from the root of the gh-pages branch and not main:/docs.

The above changes are to make the repo slimmer and only track source files. Untracking the docs directory will make collaboration a bit easier (and merging changes less painful) as the main .qmd files change.

Before pulling locally, run git rm --cached -r docs/ && git commit -m "pre-merge commit". This will remove the files from your git tree without deleting them.

Additionally, @lhe2 has requested that example analysis files be added to the quarto book. I have added changes to _quarto.yml. Please have a look at my forked version get get an idea of how this would look like.
We probably want to change the file locations so that the web address isn't so long.

@jtlandis
Copy link
Collaborator Author

I am going to temporarily close this PR

@jtlandis jtlandis closed this Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant