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
pat-s
74e8925bec
add spellchecker ( #439 )
...
fix #148
Adds a spell checker via `cspell` and fixes some spelling issues in the docs.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/439
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
2024-06-12 10:20:37 +00:00
crapStone
da1b77aa6a
Add woodpecker ci & many linters (and their required fixes) ( #377 )
...
closes #238
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/377
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-committed-by: crapStone <crapstone01@gmail.com>
2024-06-11 07:51:22 +00:00
adagio
ca0475ad93
Updates styleguide wording and terminology ( #429 )
...
Based on https://codeberg.org/forgejo/forgejo/issues/3844
Equivalent PR in the Forgejo documentation: https://codeberg.org/forgejo/docs/pulls/681
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/429
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-06-05 08:09:38 +00:00
Panagiotis "Ivory" Vasilopoulos
b9a17086c9
Style Guide: Markdown Code Blocks ( #403 )
...
Fixes #401 .
Refs: https://codeberg.org/Codeberg/Documentation/issues/401
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/403
Reviewed-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
2024-03-12 18:38:42 +00:00
Panagiotis "Ivory" Vasilopoulos
8386857b1c
Use admonition boxes more consistently
...
- Formatting fixes, relevant text adjustments
- Some more complicated cases (e.g. attribution), as well as outdated
information that should be removed in a later commit were
deliberately left unchanged.
- Some minor mistakes (speling, trailing whitespaces, punctuation)
in the admonition boxes were also fixed.
2023-11-27 07:16:04 +01:00
Panagiotis "Ivory" Vasilopoulos
9a19c900e3
Style Guide: Add image-specific rules
2023-11-27 05:37:38 +01:00
Andre601
b234b71bb7
Create new admonition boxes ( #337 )
...
Related issue: https://codeberg.org/Codeberg/Documentation/issues/330
This is my attempt at adding admonition-like boxes to the documentation. The goal is to make important stuff stand out more (especially warnings and alike).
The system uses a custom `<admonition>` box which allows classes for further customization. I.e. `<admonition class="warning">` to display a warning box.
I first wanted to make individual boxes (`<warning>`, `<note>`, ...) but decided against it, as it would've created a lot of duplicate CSS.
The CSS is designed in such a way that the first paragraph of the box is made bold (font-weight 700) while any subsequent ones are not.
The following forms of admonitions are included:
- Info (default)
- Note
- Tip
- Warning
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/337
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
2023-09-18 15:17:17 +00:00
fnetx
b4fd4812aa
Style guide is for docs only
2022-10-06 00:49:42 +02:00
