Skip to content

input-output-hk/catalyst_voices_updates

Repository files navigation

Catalyst Voice Updates

How add a new blog post

  • Navigate to the posts
  • Press the Add file button and select Create new file.
  • Create a new markdown and name the file with the following format: your-post-title.md.
  • Add template header to the file. Check the examples/template.md.
  • Add your content in markdown format. To see examples and template, check the examples folder.
  • Press the Commit changes button at the bottom of the page.
  • In Propose changes dialog select Create a new branch for this commit and start a pull request.
  • Press Save button.
  • In pull request dialog, add a title and description for your pull request.
  • Press the Create pull request button.
  • CI/CD will run and deploy the new blog post to the temporary website.
  • As soon CI/CD is finished, GitHub bot will post a comment to a new and temporary website link. Use this url to preview your blog post and iterate on it.
  • Once you are happy with the blog post, merge the pull request.
  • CI/CD will run again and deploy the new blog post to the main website.

How to update an existing (published) blog post

  • Navigate to the posts select the blog post (*.md file) you want to update.
  • Press the Edit this file button.
  • Edit your content in markdown format.
  • Press the Commit changes button at the top right of the page.
  • In Propose changes dialog select Create a new branch for this commit and start a pull request.
  • Press Propose changes button.
  • Add a title and description for your pull request.
  • Press the Create pull request button.
  • The rest of the process is the same as adding a new blog post.

How to delete an existing (published) blog post

  • Navigate to the posts select the blog post (*.md file) you want to delete.
  • Press ... button (top right corner) and select Delete this file.
  • Press the Commit changes button at the top right of the page.
  • In Propose changes dialog select Commit directly to the main branch.
  • Press Bypass rules and commit changes button.
  • The blog post will be deleted from the repository and the website after the CI/CD process is finished.

How to Use Markdown

Markdown is a lightweight markup language that allows you to format text in a simple, human-readable way. You can use it to create headings, lists, links, images, and more. When rendered, Markdown text is converted into HTML, making it easy to write content for web pages, documentation, or notes without dealing directly with complex HTML tags.

Headings

Use the # symbol followed by a space to create headings. The number of # signs determines the heading level.

# Heading Level 1
## Heading Level 2
### Heading Level 3

Bold and Italic Text

• Bold text: Wrap text in double asterisks (bold) or double underscores (bold). • Italic text: Wrap text in single asterisks (italic) or single underscores (italic).

This is bold and this is italic.

Lists

• Unordered lists: Use -, *, or + followed by a space. • Ordered lists: Use numbers followed by a dot.

  • Item 1
  • Item 2
  • Item 3
  1. Step one
  2. Step two
  3. Step three

Links

Create hyperlinks by wrapping the link text in brackets [] and following it with the URL in parentheses ():

[Catalyst](https://voices.projectcatalyst.io)

renders as:

Catalyst

Images

Similar to links, but with an exclamation mark ! in front:

![Alt text for the image](https://images.unsplash.com/photo-1733428450578-b497f84ee54b?q=80&w=2710&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D)

renders as:

Alt text for the image

Code Blocks

To format code, indent four spaces or wrap code in triple backticks (```):

def hello_world():
    print("Hello, world!")

Blockquotes

Use > at the beginning of a line to create a blockquote:

This is a quoted section of text.

Horizontal Rules

Use three or more hyphens, asterisks, or underscores on a line by themselves to create a divider:


Tables

Use | to separate columns and --- to create headers:

Column 1 Column 2 Column 3
Data 1 Data 2 Data 3
Data 4 Data 5 Data 6

Add video to HTML

src: Path to the video file (usually in tags).

<video controls width="640" height="360">
  <source src="video.mp4" type="video/mp4">
</video>

controls: Show player controls.

autoplay (with muted): Play video automatically.

muted: Video starts silent.

loop: Replay automatically after ending.

poster: Image displayed before playback.

preload (auto/metadata/none): Hint on how much video to load initially.

full example:

<!-- A video with common attributes -->
<video width="640"
       height="360"
       controls
       autoplay
       muted
       loop
       poster="images/video-poster.jpg"
       preload="metadata">

  <source src="videos/sample-video.mp4" type="video/mp4">
  <source src="videos/sample-video.webm" type="video/webm">
  <!-- Fallback text for unsupported browsers -->
  Your browser does not support the video tag.
</video>

Add image to HTML

src: Path to the image file.

  <img src="image.jpg" alt="Description">

alt: Alternate text for accessibility.

width / height: Control display size in pixels.

title: Tooltip text on hover.

loading (lazy/eager): Control when the image loads.

full example:

<!-- An image with common attributes -->
<img src="images/photo.jpg"
     alt="A serene landscape with mountains and a lake"
     width="300"
     height="200"
     title="A peaceful mountain view"
     loading="lazy">

Add youtube video to HTML

<iframe src="https://www.youtube.com/embed/7DYDsx1rMJc?si=9AIAjt5OcNO9sPBG" title="YouTube video player" frameborder="0" allow="autoplay; clipboard-write; encrypted-media; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>