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
Gusted
b66ba78d58
Update links ( #484 )
...
Update Gitea link to Forgejo link.
Add GNU link to ignore.
Remove recommendation for Atom (no longer maintained) instead recommend VSCodium.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/484
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-27 00:40:44 +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
kouett
85d333f48b
Fix typo in sphinx quickstart cmd ( #397 )
...
I believe the "pip" in front is extraneous. This is a small change.
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/397
Co-authored-by: kouett <lou@ynh.kouett.net.eu.org>
Co-committed-by: kouett <lou@ynh.kouett.net.eu.org>
2024-02-22 12:48:37 +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
Jeremy
74e7f20346
Fix codeberg-pages/examples/docs-as-code.md
2022-08-06 15:06:19 +02:00
n
3b3309a90e
Minor fixes
2022-04-17 14:28:59 +09:00
ka2in
93975e5d93
Docs-as-Code with Sphinx and Codeberg Pages ( #198 )
...
How to implement [Docs-as-Code](https://docs-as-co.de/ ) with the help of Sphinx and Codeberg Pages.
Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/198
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>
2022-02-14 22:15:05 +01:00
