Javier Pérez
941914f698
Fix lint issues ( #629 )
...
# Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/ ).
## Fixed
- Lint issues:
- Line length ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md )).
- Heading levels should only increment by one level at a time ([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md )).
- Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md )).
---
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/629
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-11-21 12:35:05 +01:00
Bastian Greshake Tzovaras
7cfd905bd4
add docs on alternative link syntax ( #638 )
...
This adds a small section to the markdown link section of the docs to also outline the `[[ link ]]` syntax that is supported in markdown texts that are rendered to html.
Closes #524 .
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/638
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-committed-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
2025-07-11 21:09:46 +02:00
Javier Pérez
e405ae93ae
Lint the documentation ( #626 )
...
# Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/ ).
## Removed
- Disable the Markdownlint rule MD024 (`Multiple headings with the same content`).
## Fixed
- Syntax errors in `.markdownlint.yaml`.
- Markdownlint issues:
- Heading levels should only increment by one level at a time([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md ))
- Hard tabs ([MD010](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md ))
- Reversed link syntax ([MD011](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md ))
- Dollar signs used before commands without showing output ([MD014](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md ))
- Multiple top-level headings in the same document ([MD025](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md ))
- Trailing punctuation in heading ([MD026](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md ))
- Ordered list item prefix([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md ))
- Emphasis used instead of a heading([MD036](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md ))
- Fenced code blocks should have a language specified ([MD040](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md ))
- Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md ))
- Link text should be descriptive ([MD059](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md ))
- Prettier issues.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/626
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 15:39:01 +02:00
Javier Pérez
c6ac9a9f94
Reduce line length limit and format content ( #623 )
...
# Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/ ).
## Changed
- Update line length limit from 500 characters to 120 characters.
## Fixed
- Most instances of these lint issues:
1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md )).
2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md )).
3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md )).
4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md )).
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 11:38:21 +02:00
Jeremy
f85f9e601a
Fix markdown/*
2022-07-26 21:46:39 +02:00
jklippel
5f022adfc6
Initial version of a Markdown documentation ( #221 )
...
Add initial version of a Markdown documentation to explain Markdown to new contributors. Also provides a styleguide to guide to a consistent use of the Markdown markup within Codeberg.
Fixes #59
Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/221
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-04-23 21:18:08 +02:00
