question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Markdown to HTML documentation build seems to be broken

See original GitHub issue

Hello,

While studying options I noticed the documentation is hard to read. It seems to me the source Markdown content tries to add anchors but ends up messing the output:

{#load_paths-option} `:load_paths`
: An array of filesystem paths or importers which should be searched
  for Sass templates imported with the [`@import`](#import) directive.
  These may be strings, `Pathname` objects, or subclasses of {Sass::Importers::Base}.
  This defaults to the working directory and, in Rack, Rails, or Merb,
  whatever `:template_location` is.
  The load path is also informed by {Sass.load_paths}
  and the `SASS_PATH` environment variable.

is rendered as image

and as you can see #load_paths-option inserted as content instead of an id on the <p> element: image

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
nex3commented, Nov 5, 2018

We’re working on totally rewriting and revamping the docs, so rendering bugs with the old docs aren’t a high priority right now.

1reaction
nex3commented, Jan 4, 2018

Looks like I forgot to deploy the update. Done!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Broken links from markdown file in docs #7734 - GitHub
My issue seems to be the same as Discussion #7246. The baseUrl is '/documentation/' I'm running latest v2.0.0-beta.21. I have a file
Read more >
Extended Syntax - Markdown Guide
Advanced features that build on the basic Markdown syntax. ... Tip: You can use HTML to create line breaks and add lists within...
Read more >
Markdown Syntax Documentation - Daring Fireball
Markdown is not a replacement for HTML, or even close to it. Its syntax is very small, corresponding only to a very small...
Read more >
How to insert a line break <br> in markdown - Stack Overflow
The problem I've encountered is that when I make a new line after the link, it is rendered with a separate <p> tag....
Read more >
Introductory Guide to Markdown for Documentation Writers
It allows you to style a digital text document using typical formatting techniques: for example, headings, emphasis, lists, images, and links.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found