rspec-documentation

0.0.11
Light Mode Dark Mode

Linking

Linking to another file in your documentation is easy. Use relative paths and apply the following simple transformation to your .md filename:

  • Convert spaces to dashes.
  • Lower-case all alphabetical characters.
  • Remove any numerical ordering prefixes (see Ordering).
  • Swap the .md extension for .html.

Example

Linking to the Spec Helper page using the following Markdown:

# rspec-documentation/pages/050-Linking.md

Linking to the [Spec Helper](spec-helper.html) page using the following _Markdown_:

The original filename in this case is 040-Spec Helper.md.


Documentation generated by rspec-documentation