Skip to content

Latest commit

 

History

History
250 lines (165 loc) · 7.28 KB

README.md

File metadata and controls

250 lines (165 loc) · 7.28 KB
Raw

EthStaker Website

Netlify Status

This is the source code for EthStaker's website, https://ethstaker.cc.

Table of Contents

Local Development

  1. Clone the repo
  2. Install dependencies: bundle install
    • Ruby may need to be installed first if not already packaged with your OS
  3. Create a feature branch off of the main branch
  4. Start the local server: bundle exec jekyll serve --config _config.yml,_config_dev.yml --incremental
    • The site.environment variable can be used to only run certain operations in production vs development
      • The --config flag uses development variables in _config_dev.yml to override those in _config.yml
    • When running the local server, saving a file automatically triggers a build so you can see the changes
      • The --incremental flag speeds up the build time by caching the builds and only updating files that were edited
  5. Go to http://localhost:4400/ to view changes

To build the site, use bundle exec jekyll build.

Resources:

Directory Structure

  • root - Contains site pages
  • _data - Contains data files, such as resources
  • _includes - This folder is designated by Jekyll for files that can be "included" into other files
    • js - Contains javascript files, most of which are compiled in assets/js/main.js
    • partials
      • components - Contains reusable non-content components, including the thml head, nav, and footer
      • content - Contains sections of html content
      • embeds - Contains embed content
    • tools - Contains include-based tools
  • _layouts - Contains layout templates used to build pages
  • _plugins - Contains custom Jekyll plugins, which have usage instructions at the top of each file
  • _posts - Contains blog posts (unused, using Paragraph instead)
  • assets - Contains js, css, images, and files

Editing Existing Content

To find the content you want to edit, first visit the markdown page in the root folder. Some content is directly in this file, like with about.md. Other content like the stewards section is pulled in from _includes/partials/content/steward.html. Pages with html content are segmented into _includes/partials/content pages for ease of maintenance.

The steward.html file contains the html for the stewards section, but as noted at the top of the page the actual data is pulled from _data/stewards.yml.

Some pages that use data files include stewards, branding, resources, support, and the staking method quiz.

Page images can be found in a folder named after the page under assets/img/. For example, the image used in about.md can be found in assets/img/about/.

Adding Resources

Adding new resources is easy!

  1. Go to _data/resources.yml
  2. Copy the template for new entries from the top of the page
  3. Remove the # to activate (uncomment) the lines, making sure to maintain the indentation
  4. Fill out the entry using the field descriptions specified at the top of the page
    • You can also use the other entries for additional guidance

Creating A New Page

  1. In the root folder, create a new markdown file. For example, staking-research.md.
  2. At the top of the page add the following "frontmatter". This is page metadata used when building the site. Only the layout is required but you should also specify the title and permalink (for explicitly). Use default as the layout for html content and markdown for markdown content. If using the markdown layout then a subheader and a button link can also be specified. 
    ---
layout: markdown
title: 
permalink: 
subheader: 

buttons:
  - link: 
    text: 
---
  3. Fill out the frontmatter. Here's an example of what it looks like for about.md: 
    ---
layout: markdown
title: About EthStaker
permalink: /about
subheader: '*"Welcoming first, knowledgable second"*'

buttons:
  - link: '#stewards'
    text: View Stewards
---
  4. Fill out the rest of the page with your content using markdown. If writing html content then break out the page into one or more sections within _includes/partials/content as html pages.
  5. For any images, create a folder under assets/img/ to place them in.

Markdown Examples

# H1

## H2

### H3

#### H4

##### H5

###### H6

[link](/)

**bold text**

*italic text*

__*bold and italic text*__

`inline code`


` ` `
code block, remove spaces between the ticks
` ` `


Section divider:

---


Unordered list:

- this is an
- unordered
    - list


Ordered list:

1. this is an
1. ordered
    1. list


Table:

header 1      | header 2
--------------|--------------
row 1, cell 1 | row 1, cell 2
row 2, cell 1 | row 2, cell 2
row 3, cell 1 | row 3, cell 2


Collapsible content:

<details markdown="1">
<summary>Expandable content</summary>
Peek a boo!

- I
    - see
        - you
</details>


Image:

![](/assets/img/logo-black.svg)

{:class="caption"}
This is an image caption


{% include partials/components/callout.html 
  type="info"
  title="Info Callout"
  content="This is a callout element."
%}

{% include partials/components/callout.html 
  type="warning"
  title="Warning Callout"
  content="This is a callout element."
%}

{% include partials/components/callout.html 
  type="danger"
  title="Danger Callout"
  content="This is a callout element."
%}


Small button:
{% include partials/components/button.html
  link="https://example.com"
  text="View test link"
  size="sm"
%}

Normal button (default):
{% include partials/components/button.html
  link="https://example.com"
  text="View test link"
%}

Large button:
{% include partials/components/button.html
  link="https://example.com"
  text="View test link"
  size="lg"
%}

Rhino Review Redirect

Since X (formerly Twitter) is banning substack links, ethstaker.cc/rhino-review can be used as a redirect using the url= parameter. For security, this only works for rhinoreview.substack.com links.

  1. Encode the substack post URL: https://www.urlencoder.org/
    • Example: https://rhinoreview.substack.com/p/rhino-review-ethereum-staking-journal becomes https%3A%2F%2Frhinoreview.substack.com%2Fp%2Frhino-review-ethereum-staking-journal
  2. Append that URL to the end of: https://ethstaker.cc/rhino-review/?url=
    • Example: https://ethstaker.cc/rhino-review/?url=https%3A%2F%2Frhinoreview.substack.com%2Fp%2Frhino-review-ethereum-staking-journal

In this example, https://ethstaker.cc/rhino-review/?url=https%3A%2F%2Frhinoreview.substack.com%2Fp%2Frhino-review-ethereum-staking-journal will be forwarded to https://rhinoreview.substack.com/p/rhino-review-ethereum-staking-journal