carpentries / carpentries-theme Goto Github PK

Hey there,

I'm encountering the following error when running make serve in a Carpentries lesson repo:

bundle exec jekyll serve
Configuration file: /Users/username/Desktop/repos/geospatial-python/_config.yml
            Source: /Users/username/Desktop/repos/geospatial-python
       Destination: /Users/username/Desktop/repos/geospatial-python/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
      Remote Theme: Using theme carpentries/carpentries-theme
  Conversion error: Jekyll::Converters::Scss encountered an error while converting 'assets/css/lesson.scss':
                    Undefined variable: "$color-warning". on line 56
jekyll 3.9.0 | Error:  Undefined variable: "$color-warning". on line 56

Looks like $color-warning is a new addition, but it isn't defined in the code boxes section of lesson.scss as the other code box colors are.

Edit: found it. Probably just missed while cherry picking!

and a description to this repo, because it should have one and because people unfamiliar with Jekyll don't stand a chance at figuring out its purpose without either of them.

It looks like USAGE.md is essentially a Readme, but it doesn't get previewed because it's not named Readme, and it may not be obvious to people to look there to understand the purpose of the repo.

We (me, @ErinBecker and @alanaschick) were trying to modify kind:"workshop" in genomics-workshop which is currently -

# What kind of thing is this ("workshop" or "lesson")?
kind: "lesson"

And found out the logic is only implemented for kind:"lesson" in navbar.html in this carpentries-theme.

It is a while now since the Carpentries style repository supports inline images:
carpentries/styles#602

However, they are rendered as inline images because those changes have not been brought into the remote theme.

It would be helpful if that feature was available.

Cross-referencing carpentries-incubator/SDC-BIDS-dMRI#197

Thanks.

Hi,

I'm currently working on https://github.com/carpentries-incubator/snakemake-novice-bioinformatics which includes many snippets of Snakemake syntax. Snakemake is a superset of Python, so elsewhere in the incubator (eg. https://github.com/carpentries-incubator/workflows-snakemake) these code blocks are just marked as {. :language-python}. This is not ideal as the header for the code block then says "Python". I've been using simply {. :language} as I write new lessons, but of course this leaves all the code monochrome and the header just says "Code".

I'm not sure how the syntax highlighting engine works in all this, but would it be possible to:

Ideally, add Snakemake-specific support, if a compatible syntax definition is available (I know some editors like Vim have support already).

Or else, provide a {. :language-snakemake} option which activates Python3 syntax highlighting but changes the heading of the code cell to "Snakemake". This will be much better than what we have now, and if a full Snakemake syntax highlighter ever becomes available in future then no change to the lessons will be needed to take advantage of it.

I know a similar change would be good for https://github.com/carpentries-incubator/workflows-nextflow. In this case the language would be "Nextflow" and if a full Nextflow highlighter is not available then Groovy syntax would be appropriate.

Cheers,
Tim

I'm porting hpc-intro to use this remote theme, and it makes for a substantially lighter repository -- thanks!
Unfortunately, in the footer of every page, the links to the CC license, The Carpentries, and the Software Carpentry Foundation are broken. (The rest seem to work.)

Can the new "Carpentries theme" footer merge in the old attributions, so we don't have confusingly no-op links?

In the link "If you teach this lesson, please tell the authors and provide feedback by opening an issue in the source repository" for beta lessons - the link URL is incorrectly set to https://github.com/<USERNAME>/<PROJECT>/issues

It should be reading the site.repository value but something is going wrong. Perhaps because https://github.com/carpentries/carpentries-theme/blob/main/_includes/life_cycle.html is missing from the gh-pages branch (and this is where the reading of the variable is happening)?

The dark blue colour of links in the bootstrap theme is not much different from black, and links are not underlined except on hover, so they can be difficult to spot.

I propose changing the colour of links generally, as I have done for this forked lesson website for a workshop being run now:

https://edcarp.github.io/genomics-r-intro/

Note: The links here have been made a bright blue. I have also changed the colour for links that have already been visited, and that is currently a bright pink, but this change is not necessary, or the colour could be modified to something else.

I can put together a PR for this, but would like to know if it would be preferable for the new CSS to be placed inside of the bootstrap file, or whether you would prefer a separate CSS file (which would also require adding a line to the base.html, and workshop.html layout files.

Hi folks,

I notice that with the "remote theme" option, there is no way to build
a lesson site if our laptop is in disconnected mode (i.e. no internet). As a context: I encountered this issue with the current version of "hpc-intro" lesson from HPC carpentry, which utilized this remote theme. I occasionally have to work with no internet, so this can create a limiting factor.

I am reporting a problem here for your awareness, though I am well aware that perhaps the solution cannot be worked out in this community alone.

A possible workaround is to install squid web caching software on the machine--perhaps this would work; I have not tested it yet. But I wonder if the remote theme software has a way to cache remote theme. I may cross post this issue on the jekyll-remote-theme issue for their attention.

Wirawan

My local builds have stopped working, encountering some issue when trying to install ffi. After a bit of digging around, I have not been able to troubleshoot the problem. But, because local builds are working okay for lessons based on the most recent version of carpentries/styles, and I get the same error on multiple different lessons using the remote theme, I think I have isolated it to the remote theme and this is the right place to report the issue. I can provide the complete output of make serve if you think that will be helpful, but the "business end" with details of the error is copied below (with local paths redacted).

error: libtool: no output file specified (specify with -o output)
Usage: libtool -static [-] file [...] [-filelist listfile[,dirname]] [-arch_only arch] [-sacLT] [-no_warning_for_no_symbols]
Usage: libtool -dynamic [-] file [...] [-filelist listfile[,dirname]] [-arch_only arch] [-o output] [-install_name name]
[-compatibility_version #] [-current_version #] [-seg1addr 0x#] [-segs_read_only_addr 0x#] [-segs_read_write_addr 0x#]
[-seg_addr_table <filename>] [-seg_addr_table_filename <file_system_path>] [-all_load] [-noall_load]
make[4]: *** [libffi_convenience.la] Error 1
make[3]: *** [all-recursive] Error 1
make[2]: *** [all] Error 2
make[1]: ***
["/path/to/lesson/repository/redacted/.vendor/bundle/ruby/2.7.0/gems/ffi-1.15.3/ext/ffi_c/libffi-x86_64-darwin20"/.libs/libffi_convenience.a]
Error 2

make failed, exit code 2

Gem files will remain installed in
/path/to/lesson/repository/redacted/.vendor/bundle/ruby/2.7.0/gems/ffi-1.15.3 for inspection.
Results logged to
/path/to/lesson/repository/redacted/.vendor/bundle/ruby/2.7.0/extensions/x86_64-darwin-20/2.7.0/ffi-1.15.3/gem_make.out

An error occurred while installing ffi (1.15.3), and Bundler cannot continue.
Make sure that `gem install ffi -v '1.15.3' --source 'https://rubygems.org/'` succeeds before bundling.

In Gemfile:
  github-pages was resolved to 218, which depends on
    github-pages-health-check was resolved to 1.17.2, which depends on
      typhoeus was resolved to 1.4.0, which depends on
        ethon was resolved to 0.14.0, which depends on
          ffi
make: *** [serve] Error 5

Is the font in the remote theme supposed to be different than the font in styles? It renders as larger, bolder, and I find it to be less readable.

It would be great to include a README or USAGE to explain how this repo should be used.

In the last hour or so pulling the remote theme has suddenly stopped working. I saw there were some recent commits in the same timeframe. The error I am seeing is:

/path-to/hpc-intro/.vendor/bundle/ruby/2.7.0/gems/jekyll-remote-theme-0.4.2/lib/jekyll-remote-theme/downloader.rb:67:in `raise_unless_sucess': 404 - Not Found (Jekyll::RemoteTheme::DownloadError)