Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tools:project_reproducibility_guides_with_gh-pages [2025/08/18 10:33] – willtools:project_reproducibility_guides_with_gh-pages [2025/08/18 10:44] (current) – [Step 4. doc/index.md] will
Line 3: Line 3:
 Let's do reproducible science! We can create a Github Page that goes along with our project repo (our project code on github) that walks others through our project, code, analyses, and how to reproduce or implement all code associated with a given publication. Let's do reproducible science! We can create a Github Page that goes along with our project repo (our project code on github) that walks others through our project, code, analyses, and how to reproduce or implement all code associated with a given publication.
  
 +To uses github's built-in support for the [[https://jekyllrb.com/|jekyll static site generator]],
 +a minimal documentation setup includes a ''docs/'' directory with two files: ''_config.yaml'' and ''index.md''.
 +<code>
 +docs/
 +  _config.yaml   # theme and configuration
 +  index.md       # actual documentation
 +</code>
 ===== Step 1. make docs/ ===== ===== Step 1. make docs/ =====
  
Line 34: Line 41:
 This file includes all of the text, links, etc. that you want to include on your Project Page! The text you write should comply to and will follow the formatting of Markdown syntax: https://github.com/Manuel83/sample/blob/master/index.md. Here is [[https://github.com/PennLINC/thalamocortical_development/blob/gh-pages/index.md | an example of an index.md file]] that served as one of Valerie’s study reproducibility guides.  This file includes all of the text, links, etc. that you want to include on your Project Page! The text you write should comply to and will follow the formatting of Markdown syntax: https://github.com/Manuel83/sample/blob/master/index.md. Here is [[https://github.com/PennLINC/thalamocortical_development/blob/gh-pages/index.md | an example of an index.md file]] that served as one of Valerie’s study reproducibility guides. 
  
 +Here's a contrived example
 +<code>
 +# My Project
 +This project **does amazing things**. Use it like
 +```bash
 +./01_organize_data.bash
 +./02_run_stats.R
 +```
 +
 +> [!NOTE]
 +> Watch out for this made up statistical //edge case//
 +</code>
 ===== Step 5. commit changes ===== ===== Step 5. commit changes =====
  
Line 39: Line 58:
 <code> <code>
 git add docs  git add docs 
-git commit -m “initiating Project Page!” #edit the message after -m to your liking+git commit -m "initiating Project Page!" #edit the message after -m to your liking
 git push origin main git push origin main
 </code> </code>
Line 53: Line 72:
  
 Your site should be live 8-)! At https://labneurocogdevel.github.io/my_reponame or https://mygitusername.github.io/my_reponame (depending where your repo lives) Your site should be live 8-)! At https://labneurocogdevel.github.io/my_reponame or https://mygitusername.github.io/my_reponame (depending where your repo lives)
 +
 +{{:tools:pasted:20250818-103700.png}}