SwedbankPay/kramdown-plantuml

confused as to how to use this.

Closed this issue · 1 comments

I'm a total beginner, trying to create my first github page and I was very excited to see a plantuml plugin for github !

I was hoping to be able to add:

```plantuml
@startuml
@enduml
...

to my markdown files in a blog post in a github page.

I tried adding the following to my _config.yml but I can't get it to render locally or on github.

markdown: kramdown
kramdown:
  plantuml:
    theme:
      name: spacelab

theme: minima
plugins:
  - jekyll-feed
  - kramdown-plantuml

Do you have an example _config.yml file I can look at?

This is my github page:

https://byronwatt.github.io/2022/11/17/plantuml.html

This is the output from the build step in github, and it doesn't seem to mention the kramdown-plantuml plugin !

Run actions/jekyll-build-pages@v1
/usr/bin/docker run --name ghcrioactionsjekyllbuildpagesv106_5cdace --label 2[9](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:10)0506 --workdir /github/workspace --rm -e "INPUT_SOURCE" -e "INPUT_DESTINATION" -e "INPUT_FUTURE" -e "INPUT_BUILD_REVISION" -e "INPUT_VERBOSE" -e "INPUT_TOKEN" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_ACTOR" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_TOOL_CACHE" -e "RUNNER_TEMP" -e "RUNNER_WORKSPACE" -e "ACTIONS_RUNTIME_URL" -e "ACTIONS_RUNTIME_TOKEN" -e "ACTIONS_CACHE_URL" -e "ACTIONS_ID_TOKEN_REQUEST_URL" -e "ACTIONS_ID_TOKEN_REQUEST_TOKEN" -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/byronwatt.github.io/byronwatt.github.io":"/github/workspace" ghcr.io/actions/jekyll-build-pages:v1.0.6
  Logging at level: debug
Configuration file: /github/workspace/./_config.yml
             Theme: minima
      Theme source: /usr/local/bundle/gems/minima-2.5.1
      GitHub Pages: github-pages v227
      GitHub Pages: jekyll v3.9.2
             Theme: minima
      Theme source: /usr/local/bundle/gems/minima-2.5.1
         Requiring: jekyll-feed
         Requiring: jekyll-seo-tag
         Requiring: jekyll-feed
         Requiring: jekyll-coffeescript
         Requiring: jekyll-commonmark-ghpages
         Requiring: jekyll-gist
To use retry middleware with Faraday v2.0+, install `faraday-retry` gem
         Requiring: jekyll-github-metadata
         Requiring: jekyll-paginate
         Requiring: jekyll-relative-links
         Requiring: jekyll-optional-front-matter
         Requiring: jekyll-readme-index
         Requiring: jekyll-default-layout
         Requiring: jekyll-titles-from-headings
   GitHub Metadata: Initializing...
            Source: /github/workspace/.
       Destination: /github/workspace/./_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
       EntryFilter: excluded /Gemfile
           Reading: _posts/2022-11-1-cmdlineoptions.markdown
           Reading: _posts/2022-11-17-plantuml.markdown
           Reading: _posts/2022-11-16-64bit_timer.markdown
        Generating: JekyllOptionalFrontMatter::Generator finished in 3.37e-05 seconds.
        Generating: JekyllReadmeIndex::Generator finished in 4.42e-05 seconds.
       Jekyll Feed: Generating feed for posts
        Generating: JekyllFeed::Generator finished in 0.000721603 seconds.
        Generating: Jekyll::Paginate::Pagination finished in 4.8e-06 seconds.
        Generating: JekyllRelativeLinks::Generator finished in 0.000511[10](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:11)2 seconds.
        Generating: JekyllDefaultLayout::Generator finished in 0.003585713 seconds.
        Generating: JekyllTitlesFromHeadings::Generator finished in 3.15e-05 seconds.
         Rendering: _posts/2022-[11](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:12)-1-cmdlineoptions.markdown
  Pre-Render Hooks: _posts/2022-11-1-cmdlineoptions.markdown
  Rendering Markup: _posts/2022-11-1-cmdlineoptions.markdown
         Requiring: kramdown-parser-gfm
  Rendering Layout: _posts/2022-11-1-cmdlineoptions.markdown
     Layout source: theme
         Rendering: _posts/2022-11-1-cmdlineoptions.markdown/#excerpt
  Pre-Render Hooks: _posts/2022-11-1-cmdlineoptions.markdown/#excerpt
  Rendering Markup: _posts/2022-11-1-cmdlineoptions.markdown/#excerpt
         Rendering: _posts/2022-11-[16](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:17)-64bit_timer.markdown
  Pre-Render Hooks: _posts/2022-11-16-64bit_timer.markdown
  Rendering Markup: _posts/2022-11-16-64bit_timer.markdown
  Rendering Layout: _posts/2022-11-16-64bit_timer.markdown
     Layout source: theme
         Rendering: _posts/2022-11-16-64bit_timer.markdown/#excerpt
  Pre-Render Hooks: _posts/2022-11-16-64bit_timer.markdown/#excerpt
  Rendering Markup: _posts/2022-11-16-64bit_timer.markdown/#excerpt
         Rendering: _posts/2022-11-[17](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:18)-plantuml.markdown
  Pre-Render Hooks: _posts/[20](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:21)[22](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:23)-11-17-plantuml.markdown
  Rendering Markup: _posts/2022-11-17-plantuml.markdown
  Rendering Layout: _posts/2022-11-17-plantuml.markdown
     Layout source: theme
         Rendering: _posts/2022-11-17-plantuml.markdown/#excerpt
  Pre-Render Hooks: _posts/2022-11-17-plantuml.markdown/#excerpt
  Rendering Markup: _posts/2022-11-17-plantuml.markdown/#excerpt
         Rendering: 404.html
  Pre-Render Hooks: 404.html
  Rendering Markup: 404.html
  Rendering Layout: 404.html
     Layout source: theme
         Rendering: about.md
  Pre-Render Hooks: about.md
  Rendering Markup: about.md
  Rendering Layout: about.md
     Layout source: theme
         Rendering: index.md
  Pre-Render Hooks: index.md
  Rendering Markup: index.md
  Rendering Layout: index.md
     Layout source: theme
         Rendering: assets/main.scss
  Pre-Render Hooks: assets/main.scss
  Rendering Markup: assets/main.scss
         Rendering: feed.xml
  Pre-Render Hooks: feed.xml
  Rendering Liquid: feed.xml
  Rendering Markup: feed.xml
  Rendering Layout: feed.xml
           Writing: /github/workspace/_site/404.html
           Writing: /github/workspace/_site/about/index.html
           Writing: /github/workspace/_site/index.html
           Writing: /github/workspace/_site/assets/main.css
           Writing: /github/workspace/_site/feed.xml
           Writing: /github/workspace/_site/2022/11/01/cmdlineoptions.html
           Writing: /github/workspace/_site/2022/11/16/64bit_timer.html
           Writing: /github/workspace/_site/2022/11/17/plantuml.html
                    done in 0.[23](https://github.com/byronwatt/byronwatt.github.io/actions/runs/3501545013/jobs/5865286783#step:4:24)9 seconds.
 Auto-regeneration: disabled. Use --watch to enable.

I switched to using the minimal-mistakes theme, and now it's working !

Not sure what I was doing wrong before, or what i'm doing right now !