Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.53 KB

README.md

File metadata and controls

67 lines (46 loc) · 1.53 KB
Raw


Optimism

Optimism is Ethereum, scaled.


OP Stack Specification

This repository contains the Specs Book.

Contributing

Dependencies

Rust Toolchain

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

mdbook + plugins

cargo install mdbook mdbook-katex mdbook-linkcheck mdbook-mermaid

Serving the book locally

just serve

Linting

doctoc is used to automatically add a table of contents.

just lint-specs-toc-check

To fix markdown linting errors:

just lint-specs-md-fix

See the markdownlint rule reference and an example config file.

Justification for linting rules in .markdownlint.json:

  • line_length (!strict && stern): don't trip up on url lines
  • no-blanks-blockquote: enable multiple consecutive blockquotes separated by white lines
  • single-title: enable reusing <h1> for content
  • no-emphasis-as-heading: enable emphasized paragraphs

To lint links:

just lint-links

[lychee][lychee] is used for linting links.