Git Product home page Git Product logo

marp-action's People

Contributors

ralexander-phi avatar unseenwizzard avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

marp-action's Issues

Images don't get published with the Action

Hello,
I really like the idea of automatically converting my markdown to html and publishing them to GH pages via this action. Unfortunately I couldn't get images working.
I had a really basic setup, one of my markdown slides had images in it, using the normal syntax of:

Some text: ![](image_file_name.png)
Some other text: ![](some_other_image_file.png)

I've tried a number of iterations:

  • like above, having the image files in the same directory as the markdown file itself
  • putting the images in a <path_to_markdown_file>/docs/assets/images directory and using docs/assets/images/image_file_name.png inside the parens in my slides
  • putting the images in a <repo_root>/docs/assets/images directory
  • putting the images in a <repo_root>/img directory
    (the latter two make sense for not working I guess as my --input_dir doesn't contain the repo's root, see below)

None of which worked ๐Ÿ˜ž

If i don't use this action, but commit my markdown slides to the gh-pages branch directly, the images do show up. But if I use the action, commit to devel and have the Action convert and publish then the images become broken links, with a 404 error.

I'm using the master version of your plugin. Here's my action config file:

# This is a basic workflow to help you get started with Actions

name: Publish Pages

# Controls when the action will run.
# Triggers the workflow on push events for the devel branch
on:
  workflow_dispatch:
  push:
    branches:
      - devel

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # TODO(balint) move to self hosted runners once the repo is allowed to use them
    # runs-on: [self-hosted]
    runs-on: ubuntu-latest
    - uses: actions/checkout@v2
    - name: Build & Deploy to GitHub Pages
      env:
        MARP_ARGS: "--input-dir markdown_slides/ --output docs/"
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        GITHUB_REPOSITORY: ${{ github.repository }}
        PUBLISH_TO_BRANCH: gh-pages

        # You'll want to set this to your domain
        BASE_URL: <my base URL is here>

      # consider using a tagged release here
      # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses
      uses: ralexander-phi/marp-action@master

Can this action support multiple branches in a single repository?

This action looks like it will be really useful, so thank you very much for creating it!

I was a long time user of GitPitch before it closed down, and I am looking to see whether I can use Marp as a replacement.

The way I used to create my GitPitch decks was that I would work off of the master/main branch, and once I gave a presentation I would create a branch at the point that I gave the talk, so that anyone who wanted to review the slide deck for that version of the talk could go back and look at it, and I could continue to tweak/change the slide deck on the master branch.

An example of this can be found here:

https://github.com/gep13-talks/CakeDemos

Is it possible for this action to support the creation of multiple folders in the site that is published to GitHub pages? i.e. a folder for each branch, and then I could give folks a link to the folder to view that version of the slide deck.

Thanks for any help that you can offer here!

Add more instructions if not using a template repo

I really like this action and I just started using this on one of my small projects.

It took me sometime to figure out how to setup the action just right since reading the bash script I couldn't figure out where some of the arguments were coming from. Perhaps you can include something in the instructions on how to add it to an existing projects so that all the environment variables are just right.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.