Text-Runner automatically verifies the static structure of your documentation, in particular that local images point to existing files and local links point to existing files or directories.
By default, Text-Runner checks only links and images pointing to local files and
directories. Use the --online switch to add checking links pointing to the
internet. Please note that this will slow down your documentation test suite and
make it more brittle.
If you use static site generators like Jekyll,
Gatsby, or Docusaurus to
transpile the Markdown to HTML, the links used in Markdown might not match the
location of the linked files. In these situations, you can describe how your
site generator maps links using the publications section inside Text-Runner's
configuration file.
As an example, let's say you use a static site generator for your blog. The
source code contains blog posts as Markdown files inside the content/posts/
folder. The website shows the blog posts as HTML files at the /blog path. Here
is the publication that explains Text-Runner that for example the file
content/posts/welcome.md gets mapped to the URL path /blog/welcome.html:
publications:
- localPath: /content/posts
publicPath: /blog
publicExtension: .htmlMore examples at the end-to-end test for publications
Read more about:
- writing your own user-defined actions
- use external actions