gioser

tawasuyu/taffy

A high performance rust-powered UI layout library

Rust 498HTML 254C 19JavaScript 81339 Definiciones

Fix Markdown linting in CI (#35)

* Remove markdown-lint.yml

* Double-check all code, not just changed code

* Revert "Remove markdown-lint.yml"

This reverts commit 8262fef39ffbef233d4707f8b154c2355689d6de.

* Format readme according to markdown-lint rules

682c25cd8bd5125702a77294304e91a18f31b764 · por Alice Cecile · (hace 4 años) · padre d703163ff · ver el árbol en este commit

Delta semántico

Ninguna definición cambió: el cambio es de texto, documentación o datos.

3 archivos · +30 −8

diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml
index da6285182..03bf5690a 100644
--- a/.github/linters/.markdown-lint.yml
+++ b/.github/linters/.markdown-lint.yml
@@ -18,10 +18,11 @@
 ###############
 # Rules by id #
 ###############
-MD013:
-  line_length: 160
+# MD013:
+#  line_length: 120
 
 #################
 # Rules by tags #
 #################
 # blank_lines: false  # Error on blank lines
+line_length: false # Ignore excessively long lines
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index e226a60d3..ef7ae04c1 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -90,6 +90,6 @@ jobs:
       - name: Run Markdown Lint
         uses: docker://ghcr.io/github/super-linter:slim-v4
         env:
-          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_ALL_CODEBASE: true
           VALIDATE_MARKDOWN: true
           DEFAULT_BRANCH: master
diff --git a/README.md b/README.md
index e2caf8d2b..4fce73614 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,17 @@
 # Stretch2
+
 [![GitHub CI](https://github.com/DioxusLabs/stretch/actions/workflows/ci.yml/badge.svg)](https://github.com/DioxusLabs/stretch/actions/workflows/ci.yml)
 [![crates.io](https://img.shields.io/crates/v/stretch2.svg)](https://crates.io/crates/stretch2)
 
 > THIS IS A FORK OF THE ORIGINAL STRETCH. CURRENTLY MAINTAINED BY DIOXUS.
 
-Stretch2 is an implementation of Flexbox written in [Rust](https://www.rust-lang.org). The goal of stretch2 is to provide a solid foundation for layout across all platforms with a specific focus on mobile. Long term we want stretch2 to not only support flexbox but also many other layout algorithms such as grid layout. Stretch was made for and powers https://visly.app.
+Stretch2 is an implementation of Flexbox written in [Rust](https://www.rust-lang.org).
+The goal of stretch2 is to provide a solid foundation for layout across all platforms with a specific focus on mobile.
+Long term we want stretch2 to not only support flexbox but also many other layout algorithms such as grid layout.
+Stretch was made for and powers <https://visly.app>.
 
 ## Goals
+
 Before using or contributing to stretch2 it is good to be aware of the core goals of the project. These are goals we are working towards, not necessarily features we currently support.
 
 - High performance
@@ -24,9 +29,11 @@ Before using or contributing to stretch2 it is good to be aware of the core goal
 - JavaScript / TypeScript
 
 ## Usage
+
 Stretch2 is built in Rust but comes with bindings to multiple languages and platforms so you can use it in a way that feels natural to your project.
 
 ### Rust
+
 ```toml
 # Cargo.toml
 
@@ -64,6 +71,7 @@ fn main() -> Result<(), stretch2::Error> {
 ```
 
 ### Android
+
 ```groovy
 // Build.gradle
 
@@ -94,6 +102,7 @@ Log.d(TAG, "width: ${layout.width}, height: ${layout.height}")
 ```
 
 ### iOS
+
 ```ruby
 # Podfile
 
@@ -114,6 +123,7 @@ print("width: \(layout.width), height: \(layout.height)")
 ```
 
 ### JavaScript
+
 ```bash
 > npm install --save stretch-layout
 ```
@@ -132,6 +142,7 @@ console.log(layout.width, layout.height);
 ```
 
 ## Contributing
+
 Contributions are very welcome. Though we ask that you open an issue or pull request early in the process (before writing code) so we can discuss solutions and additions before you start spending time on implementing them. There are some specific areas where we would be extra happy to receive contributions in.
 
 - Binary size reduction
@@ -145,6 +156,7 @@ Contributions are very welcome. Though we ask that you open an issue or pull req
 - Documentation & Examples
 
 ### Installation
+
 If you don't have Rust installed you have to do that first as well as install some components that we make use of to format and lint the codebase. For more on Rust see their [website](https://www.rust-lang.org).
 
 ```bash
@@ -164,9 +176,12 @@ cargo test
 If you have made any changes to the API you should also update and run tests for all the platform bindings located in `/bindings/*`.
 
 ### Testing
-Stretch2 is tested by validating that layouts written in stretch2 perform the same as in Chrome. This is done by rendering an equivalent layout in HTML and then generating a Rust test case which asserts that the resulting layout is the same when run through stretch.
 
-You can run these tests without setting up a webdriver environment but if you are looking to add any test case you will need to install [chromedriver](http://chromedriver.chromium.org). If you are developing on macOS this is easy to do through brew.
+Stretch2 is tested by validating that layouts written in stretch2 perform the same as in Chrome.
+This is done by rendering an equivalent layout in HTML and then generating a Rust test case which asserts that the resulting layout is the same when run through stretch.
+
+You can run these tests without setting up a webdriver environment but if you are looking to add any test case you will need to install [chromedriver](http://chromedriver.chromium.org).
+If you are developing on macOS this is easy to do through brew.
 
 ```bash
 brew tap homebrew/cask
@@ -178,7 +193,13 @@ Once you have chromedriver installed and available in `PATH` you can re-generate
 To add a new test case add another HTML file to `/test_fixtures` following the current tests as a template for new tests.
 
 ### Benchmarking
-Benchmarks build on the same infrastructure as testing, and actually benchmarks are automatically generated from test fixtures just like tests. Run `cargo bench` to run benchmarks locally.
+
+Benchmarks build on the same infrastructure as testing, and actually benchmarks are automatically generated from test fixtures just like tests.
+Run `cargo bench` to run benchmarks locally.
 
 ## Relationship to Yoga
-[Yoga](https://www.yogalayout.com) is a cross-platform implementation of Flexbox written in C. Yoga is a fantastic project but has some fundamental issues which we hope to resolve. Compared to Yoga we aim to have a stronger adherence to web standards, a flexible architecture eventually supporting multiple layout algorithms, and future performance improvements including multi-threaded layout. In addition to this we aim to use a safer language with a more modern codebase.
+
+[Yoga](https://www.yogalayout.com) is a cross-platform implementation of Flexbox written in C.
+Yoga is a fantastic project but has some fundamental issues which we hope to resolve.
+Compared to Yoga we aim to have a stronger adherence to web standards, a flexible architecture eventually supporting multiple layout algorithms, and future performance improvements including multi-threaded layout.
+In addition to this we aim to use a safer language with a more modern codebase.