Code Monkey home page Code Monkey logo

pandoc-uikit's Introduction

pandoc uikit

A pandoc uikit html template, to convert any document in a website automatically.

Includes a sticky adaptive menu and some other nice things: Example Result.

Install:

git clone https://github.com/igor-lirussi/pandoc-uikit

Example (fetch latest pandoc README and transform to HTML)

pandoc https://raw.githubusercontent.com/jgm/pandoc/master/MANUAL.txt -o index.html -f markdown --template ./pandoc-uikit/standalone.html --toc --toc-depth=2

Start a server in current directory, e.g.:

php -S localhost:8080

Point a browser to http://localhost:8080

GitHub Actions

Clone this template-repo in your repo as in "Install" section or with the action below:

      - name: Clones your git repo 
        uses: actions/checkout@v2
      - name: Clones Pandoc template repo
        run: |
          git clone https://github.com/igor-lirussi/pandoc-uikit

Convert from tex (or other docs) to html

      - name: Pandoc tex conversion
        uses: docker://pandoc/latex:latest
        with:
          args: >-
            -d ./pandoc-uikit/config.yaml 
            -o ./index.html 
            main.tex

Commit in a new branch (gh-pages)

      - name: Commit the new gh-pages html
        run: |
          git add ./index.html  #save it from clean
          git commit -m "Invisible commit"  #to allow the checkout later without files in staging area
          rm -rdf pandoc-uikit/.git*    #removes .github folder of pandoc otherwise it does NOT get deleted by clean
          git clean -fxd    #removes tracked files uncommitted (log generated by the docker, the /pandoc-uikit repo, ...
          git checkout gh-pages
          # delete everything
          git rm -rf .
          git clean -fxd
          #get again this repo
          git clone https://github.com/igor-lirussi/pandoc-uikit
          rm -rdf pandoc-uikit/.git*
          #get also the folders needed from the main branch
          git checkout -f main Extra
          git checkout -f main index.html
          git status
          # git cherry-pick main, alternatives
          git add .
          git commit -m 'Updated gh-pages'
          git push

Variables

google analytics:

 --variable=analytics:XXX-ANALYTICS-CODE 

uikit CSS

--variable=template_css:/path/to/uikit.css

Licence

MIT © Dennis Iversen

pandoc-uikit's People

Contributors

diversen avatar igor-lirussi avatar onze 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.