Callouts not rendering about just-the-docs HOT 3 CLOSED

Thanks so much, Matt! I never would have been able to figure this out on my own. Really appreciate your help.

from just-the-docs.

@mattxwang following up on my email with an issue here! Thanks in advance.

from just-the-docs.

Hi @rachaelsalisbury, thanks for submitting an issue. The repository helps me debug quite a bit! Basically, the repo you've linked (and thus, your site) has copied over the source code of our theme rather than the library; the latter is what users should use. In particular, this copy was made prior to version 0.4 (when callouts were introduced). This means you can't easily use new versions of the library as we release them (such as new features like callouts).

It seems like you bumped the version in the .gemspec, but this doesn't actually update the library (what a gemspec actually does is a bit out of scope of your use-case).

Here is the minimum change you need to do to get your sample repo to work (I just did this locally):

1. other than _sass/color_schemes/np_color_scheme.scss, delete the entire contents of _includes, _layouts, and _sass: these are all old remnants of source code. They're included as part of our library, so you don't need to have a (potentially outdated) copy.
2. In _config.yml, add theme: just-the-docs (this tells Jekyll to use our library)
3. Change your Gemfile to have the following contents (which properly installs our library):

source 'https://rubygems.org'

gem "jekyll", "~> 4.3.2" # installed by `gem jekyll`
# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2

gem "just-the-docs", "0.6.1" # pinned to the current release

4. Re-run bundle install
5. Re-run bundle exec jekyll serve; observe that callouts now work

You should be able to repeat similar steps for your confidential site.

You might also find it easier to "start from scratch" by starting with the template and:

• moving over all of your content, i.e. the content of docs/
• re-adding any custom code you've added, i.e. _sass/color_schemes/np_color_scheme.scss

Either should resolve your problem. Let me know if this works / if you have any follow-ups!

from just-the-docs.