Giter VIP home page Giter VIP logo

slide-demo's Introduction

Asciidoctor Github Pages Template

Converting

  1. will be converted into asciidoc format
  2. will be converted into asciidocs slides

Action

GitHub Actions will automatically convert the .adoc files into html document. You can configure the input and output path with the environmental variables at the top of the actions.

Note: This will not change the configuration for the scripts

jobs:
  build:
    name: Build & Publish ๐Ÿš€
    runs-on: ubuntu-latest
    env:
      INPUTPATH: docs
      OUTPUTPATH: dist
      SLIDES: true
      BRANCH: gh-pages
INPUTPATH OUTPUTPATH SLIDES BRANCH
type string string boolean string

Directory Trigger

After changing the input path make sure to also change the directory trigger at the top of the file.

on:
  push:
    branches:
      - 'main'
    paths:
      - docs/**

Just change docs to the prefered input directory.

Scripts

Sometimes it is useful to just convert or push it locally for a quick update. In the root directory are two scripts

Convert

This script will just convert it into the ouput directory. See table below for the parameters..

./convert.sh <input-dir> <output-dir> <slides-convert>

Publish

This script will convert the documents and publish them to the gh-pages branch. See table below for the parameters.

./publish.sh <input-dir> <output-dir> <slides-convert>

Config

You can configure the inut and output dir in the config.sh file.

input-dir output-dir slides-convert
isOptional true true true
defaultValue input output true
type string string boolean

slide-demo's People

Contributors

bauepete avatar

Watchers

 avatar

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.