pactus-project / pips

Pactus Improvement Proposal

Pactus Improvement Proposals (PIPs)

PIPs, or Pactus Improvement Proposals, define standards and guidelines to improve the Pactus project. PIPs are designed to be a transparent and collaborative way to propose and discuss changes to the Pactus network. The PIP-1 defines the proposal workflows.

The status page tracks and lists all PIPs in this repository.

Running Locally

To get started, install Jekyll, first. Additionally, make sure to install Yarn for efficient dependency management, including Bootstrap.

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

git clone https://github.com/pactus-project/pips.git
cd PIPs
yarn install ## To install bootstrap
bundle install
bundle exec jekyll serve

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.