Sign upLogin

bueltge/marksimple

View on GitHub
Star
README.md

Summary

Maintainability
Test Coverage

Consider starting bulleted lists at the beginning of the line
Open

 * [PHP Live Regex](https://www.phpliveregex.com/) Really helpful in PHP context.
Severity: Info
Found in README.md by markdownlint

MD006 - Consider starting bulleted lists at the beginning of the line

Tags: bullet, ul, indentation

Aliases: ul-start-left

This rule is triggered when top level lists don't start at the beginning of a line:

Some text

  * List item
  * List item

To fix, ensure that top level list items are not indented:

Some test

* List item
* List item

Rationale: Starting lists at the beginning of the line means that nested list items can all be indented by the same amount when an editor's indent function or the tab key is used to indent. Starting a list 1 space in means that the indent of the first nested list is less than the indent of the second level (3 characters if you use 4 space tabs, or 1 character if you use 2 space tabs).

Line length
Open

And the default `Logger` is the `NullLogger` it will be created when declaring `MarkSimple` class instance. The more details about `psr/log`, please visit this [link](https://www.php-fig.org/psr/psr-3/).
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Consider starting bulleted lists at the beginning of the line
Open

 * Headers, `h1` - `h6` - `#` to `######` before the string
Severity: Info
Found in README.md by markdownlint

MD006 - Consider starting bulleted lists at the beginning of the line

Tags: bullet, ul, indentation

Aliases: ul-start-left

This rule is triggered when top level lists don't start at the beginning of a line:

Some text

  * List item
  * List item

To fix, ensure that top level list items are not indented:

Some test

* List item
* List item

Rationale: Starting lists at the beginning of the line means that nested list items can all be indented by the same amount when an editor's indent function or the tab key is used to indent. Starting a list 1 space in means that the indent of the first nested list is less than the indent of the second level (3 characters if you use 4 space tabs, or 1 character if you use 2 space tabs).

Line length
Open

Yes, **I know**, it give a lot of __open projects__ that solve the same goal. However it was fun to write my custom parser, only with the rules there I need, not to much overhead. Yes, also I mean that other packages more solid solid, lof of usages, bot not points enough to learn about regex and markdown. Besides *I know* a regex parser is not the best, fastest way, but also here, _I would to teach me in this context_.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Consider starting bulleted lists at the beginning of the line
Open

 * PHP 7.4
Severity: Info
Found in README.md by markdownlint

MD006 - Consider starting bulleted lists at the beginning of the line

Tags: bullet, ul, indentation

Aliases: ul-start-left

This rule is triggered when top level lists don't start at the beginning of a line:

Some text

  * List item
  * List item

To fix, ensure that top level list items are not indented:

Some test

* List item
* List item

Rationale: Starting lists at the beginning of the line means that nested list items can all be indented by the same amount when an editor's indent function or the tab key is used to indent. Starting a list 1 space in means that the indent of the first nested list is less than the indent of the second level (3 characters if you use 4 space tabs, or 1 character if you use 2 space tabs).

Line length
Open

[![Maintainability](https://api.codeclimate.com/v1/badges/3ce79c7b4118c47951cc/maintainability "Maintainability")](https://codeclimate.com/github/bueltge/marksimple/maintainability)
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

Install static via download, clone the repository or use dependency management via Composer
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Consider starting bulleted lists at the beginning of the line
Open

 * [GitHub Repository](https://github.com/bueltge/marksimple)
Severity: Info
Found in README.md by markdownlint

MD006 - Consider starting bulleted lists at the beginning of the line

Tags: bullet, ul, indentation

Aliases: ul-start-left

This rule is triggered when top level lists don't start at the beginning of a line:

Some text

  * List item
  * List item

To fix, ensure that top level list items are not indented:

Some test

* List item
* List item

Rationale: Starting lists at the beginning of the line means that nested list items can all be indented by the same amount when an editor's indent function or the tab key is used to indent. Starting a list 1 space in means that the indent of the first nested list is less than the indent of the second level (3 characters if you use 4 space tabs, or 1 character if you use 2 space tabs).

Line length
Open

 * Code Blocks, `pre` - `    ` (4 spaces) or `    ` (tab) in each line or the fenced code blocks by placing triple backticks and optional the language identifier,
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Code block style
Open

    // Example with four spaces.
Severity: Info
Found in README.md by markdownlint

Line length
Open

On the way to the goal of my simple parser I use lot of tests, tries on the online Regex testers. Thanks a lot to the authors of this followed two sites, great!
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

My class supports currently the follow syntax. But Pull Request are really welcome and the solution give you the possibility to add your own rule.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Header levels should only increment by one level at a time
Open

#### Requirements
Severity: Info
Found in README.md by markdownlint

MD001 - Header levels should only increment by one level at a time

Tags: headers

Aliases: header-increment

This rule is triggered when you skip header levels in a markdown document, for example:

# Header 1

### Header 3

We skipped out a 2nd level header in this document

When using multiple header levels, nested headers should increase by only one level at a time:

# Header 1

## Header 2

### Header 3

#### Header 4

## Another Header 2

### Another Header 3

Line length
Open

The class is simple and I use it for my own documentation, there I write in markdown. Here and there is the result a single oage to help in each day to find the right syntax, hints, background and others. You can see this on this examples:
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

A simple Markdown parser, short and only with the rules there I currently need. The function is regex based and it is possible to enhance your custom rules.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

The solution is still active in his tests, you find it [here](https://bueltge.de/thueringen-erfahren/). This test of the class is also build as [PWA](https://developers.google.com/web/progressive-web-apps/), Progressive Web App. It was only an fun project for me to understand it on a really simple site how it works. But is important, if you see the directory `test` in this repository here and wounder about so much files there are not in the context of the Markdown parser. If you will check the PWA, use it on your mobile or play with Chrome/WebInspector.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Line length
Open

See the test directory for an example with two different usages. The test directory works as PWA, for examples see only the file `index.php`.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Consider starting bulleted lists at the beginning of the line
Open

 * [MarkSimple Tests](https://bueltge.de/marksimple/test/)
Severity: Info
Found in README.md by markdownlint

MD006 - Consider starting bulleted lists at the beginning of the line

Tags: bullet, ul, indentation

Aliases: ul-start-left

This rule is triggered when top level lists don't start at the beginning of a line:

Some text

  * List item
  * List item

To fix, ensure that top level list items are not indented:

Some test

* List item
* List item

Rationale: Starting lists at the beginning of the line means that nested list items can all be indented by the same amount when an editor's indent function or the tab key is used to indent. Starting a list 1 space in means that the indent of the first nested list is less than the indent of the second level (3 characters if you use 4 space tabs, or 1 character if you use 2 space tabs).

Hard tabs
Open

 * Code Blocks, `pre` - `    ` (4 spaces) or `    ` (tab) in each line or the fenced code blocks by placing triple backticks and optional the language identifier,
Severity: Info
Found in README.md by markdownlint

MD010 - Hard tabs

Tags: whitespace, hard_tab

Aliases: no-hard-tabs

This rule is triggered by any lines that contain hard tab characters instead of using spaces for indentation. To fix this, replace any hard tab characters with spaces instead.

Example:

Some text

    * hard tab character used to indent the list item

Corrected example:

Some text

    * Spaces used to indent the list item instead

Line length
Open

Good news, this plugin is free for everyone! Since it's released under the [MIT License](https://github.com/inpsyde/marksimple/blob/master/LICENSE) you can use it free of charge on your personal or commercial website.
Severity: Info
Found in README.md by markdownlint

MD013 - Line length

Tags: line_length

Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)

This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.

This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.

You also have the option to exclude this rule for code blocks and tables. To do this, set the code_blocks and/or tables parameters to false.

Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.

Expected an indentation at 0 instead of at 1.
Open

 * Horizontal line, `---`
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Headers, `h1` - `h6` - `#` to `######` before the string
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Inline Code, `code` - an ``` backtick before and after the code string
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [DebuggexBeta](https://www.debuggex.com/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [My Git Notes](https://bueltge.de/git/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Italic text, `em` - an `*` or `_` before and after the string
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [regular expressions 101](https://regex101.com/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [GitHub Repository](https://github.com/bueltge/marksimple)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [MarkSimple Tests](https://bueltge.de/marksimple/test/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Unordered list, `ul` - `*` for each line
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Break, new line, `<br>`
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [PHP Live Regex](https://www.phpliveregex.com/) Really helpful in PHP context.
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Code Blocks, `pre` - `    ` (4 spaces) or `    ` (tab) in each line or the fenced code blocks by placing triple backticks and optional the language identifier,
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * PHP 7.4
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [RegExr](https://regexr.com/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Image, `![](path/to/image.png "Alt text")`
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [Learn Regex The Easy Way](https://github.com/zeeshanu/learn-regex)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Links, `a` - `[Link Text](Link URL)`
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [My Markdown Notes](https://bueltge.de/md/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [Thüringen erfahren - a one pager for a bicycle event](https://bueltge.de/thueringen-erfahren/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * [My Linux command notes](https://bueltge.de/linux/)
Severity: Minor
Found in README.md by editorconfig

Expected an indentation at 0 instead of at 1.
Open

 * Strong, bold text, `strong` - `**` or `__` before and after the string
Severity: Minor
Found in README.md by editorconfig

There are no issues that match your filters.

Category
Status