Pactus website

This repository contains all the content for the https://pactus.org website.

Contributing to Documentation

Contributions to the website, including fixing typos or grammatical errors, are always welcome. To contribute, simply edit the relevant page or open a pull request.

Running Locally

For running the website locally, you need to have the following installed on your machine:

• Hugo
• Yarn or npm

Pactus website is powered by Hugo. Make sure you have installed the extended version of hugo on your machine.

Now, clone this repository and run it locally using the following commands:

git clone https://github.com/pactus-project/pactus-website.git
cd pactus-website

yarn install
hugo server

Guidelines

Follow these guidelines to ensure high-quality contributions to the Pactus website project.

New Blog Post

To create a new blog post, run:

hugo new content --kind blog blog/your-post-name.md

This command will create a new markdown file in the content/blog directory with the following front matter:

+++
title = "Title goes here"
description = "Description goes here (Optional)"
author = "Your Name"
date = 2024-10-20T16:39:03+08:00
tags = [""]
image = "post-image.png"
+++

Blog Assets

All blog post assets, including images, should be kept inside the /assets/blog/<post-filename>/ folder. The blog post file name and the directory you create for its assets should have the same name.

Images

For optimizing images in markdown files, use the image shortcode:

![Post Image]{{<image "post-image.png">}}

You can specify the absolute image path like this:

![Post Image]{{<image "/images/post-image.png">}}

Other Assets

Other assets, like PDF files, can be linked similarly:

[Post Doc]{{<asset "post-doc.pdf">}}

Markdown

Markdown is a lightweight markup language that uses plain text formatting syntax to convert text into HTML, making it easy to read and write for web content.

Linting

Markdown linting helps ensure consistent style and formatting, detects syntax errors, improves readability, and maintains best practices in Markdown documents.

To lint Markdown files, you can use the mdl (MarkdownLint) command-line tool. This tool checks your Markdown files against a set of rules and provides feedback on any issues found.

To install mdl, first you need to install Ruby. Once you ensure Ruby installed on your system, you can install mdl by running:

gem install mdl

Then you can lint your Markdown files with the following command:

mdl --style=.mdlrc.rb ./content

This command will check all documents in the content folder for any linting issues and output them in the terminal.

Additional Commands

There are some additional commands to check and improve the changes. Below are some useful commands:

Command	Task
yarn run start	Start the website locally and watch for css changes
yarn run build	Build the website locally
yarn run prettier:setup	Set up Prettier
yarn run prettier	Check all HTML and Markdown files using Prettier
yarn run lint:md:setup	Set up Markdown linting
yarn run lint:md	Lint Markdown files
yarn run lint:yml:setup	Set up YAML linting
yarn run lint:yml	Lint YAML files
yarn run htmlproofer:setup	Set up html-proofer for link checker
yarn run htmlproofer	Check for broken links using html-proofer
yarn run exif	Remove Meta Information from images using ExifTool

Deployment

Updating the main branch will automatically deploy this repository through deploy Github action.