Giter Club home page Giter Club logo

macaquenet.github.io's Introduction

ManyPrimates website

Source code for https://manyprimates.github.io/

Structure

(not all folders shown)

.
├── _config.yml         <-- some general settings/info
├── _includes           <-- building blocks for each page
├── _layouts            <-- collection of different page layouts
├── assets
│   ├── conferences     <-- put PDFs for slides/posters here
│   ├── images          <-- put images here
│   └── pdfs            <-- put PDFs for published papers here
├── index.md            <-- edit these .md files to edit content
├── pilot.md
├── project1.md
├── project2.md
└── [...].md

Prerequisites

You need some basic familiarity with these tools to make edits to the website. The good news is that 2-3 commands will cover 90% of use cases, so don't get overwhelmed. There's no need to learn everything.

  • Git & GitHub:
    • to sync this online folder/'repo' with one on your computer and keep track of who made what changes and when
    • check out, e.g., this guide to get started
  • Markdown:
    • to format text on a website with really simple syntax in plain-text files (e.g. **I want to make a bold statement.** turns into I want to make a bold statement.)
    • check out, e.g., this guide to get started

Knowledge of HTML is very optional. If you already know some, you can mix and match Markdown and HTML bits when editing the .md files. Sometimes that's useful because there's no equivalent in Markdown for what you want to do (e.g., this line to embed the Twitter widget on the news page)

Making changes to the content

  • Fetch any upstream changes to your local repo (i.e., make sure you have the latest version)
    • You can ignore almost all of the folders/files. It's set up so that you simply edit the content and it'll do the rest automatically
  • Edit the text in the Markdown .md files
  • Put images, PDFs, etc. that you reference in the assets subfolders
  • Use relative urls whenever possible, e.g. pilot.html instead of https://manyprimates.github.io/pilot.html
  • Do not touch the files in the folders that start with an _underscore unless you're sure you know what you're doing!

Setting up a local site to preview changes

  • Have a clone of the github repo on your local machine
  • Install Jekyll: gem install bundler jekyll
    • If that gives you any errors, google them... or check here
  • Install jekyll-seo-tag: gem install bundler jekyll-seo-tag
  • cd into the git repo for the website
  • Build local Jekyll site: bundle exec jekyll serve
  • Open browser and go to: http://localhost:4000
  • You should see any changes you save on your local .md files (refresh)
  • Push your changes when you're happy with the preview! GitHub will then (re)build the site (typically within a few minutes)

I have questions ok maybe I broke something 😅

Ask @jwatzek (Slack is best)

macaquenet.github.io's People

Contributors

jwatzek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.