Documentation/content/improving-documentation/preview.md
Jan Klippel 5bdac45ee5 Create a new section documentation
Extract important articles from the now lengthy FAQ.
This helps to find the documented basics.
Move the Docs-Contributor-FAQ to the new documentation section.
2022-04-14 12:34:58 +02:00

12 lines
545 B
Markdown

---
eleventyNavigation:
key: PreviewArticle
title: Can I preview my article?
parent: ImprovingTheDocumentation
order: 15
---
Yes, but currently only if you're working with a local clone of the repository. In that case, simply follow the instructions in the [`README.md`](https://codeberg.org/codeberg/documentation/src/README.md) file to set up and run a local preview.
It is recommended to set this up, because it can help you a lot in spotting errors that would otherwise go unnoticed, especially aesthetic errors and broken links.