GithubHelp home page GithubHelp logo

joshooaj / mkdocs-deploy Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 2.69 MB

GitHub Action to publish GitHub Pages using MkDocs

Home Page: http://www.joshooaj.com/mkdocs-deploy/

License: MIT License

TypeScript 96.52% Shell 2.63% Dockerfile 0.86%

mkdocs-deploy's People

Contributors

dependabot[bot] avatar joshooaj avatar

Stargazers

 avatar

mkdocs-deploy's Issues

Add support for unresolved yaml tags

I'm using the js-yaml module right now and haven't fully wrapped my head around it and the idea of custom tags. Currently, the following YAML would cause the action to fail:

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

I think I want any tag to be treated as a string as I'm only reading a user-supplied mkdocs.yml in order to retrieve the name of the theme, which is used to figure out which package to install to add support for the theme.

On the other hand, I might just require a requirements.txt file if a mkdocs.yml is supplied, and expect that the requirements file already includes the theme. That way I only ever interact with yaml when writing a basic mkdocs.yml at runtime when no user-defined configuration was provided.

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.