Giter VIP home page Giter VIP logo

docker-drawio-mkdocs's Introduction

Static mkdocs generator (including drawio)

What is it?

A script that will (re)build a local container to generate a static website for your MkDocs documentation, written in markdown and including generated drawio images.

How to use

Fork this repository, add your own content to the docs directory and generate the static content using update.sh.

Running update.sh will (re)build a local docker container and generate a site-directory with a static version of your mkdocs :)

Requires docker and git commands to be available.

drawio?

drawio is a neat solution to draw your images and save them to XML, SVG or binary formats (such as PNG).

Files generated using draw.io and saved as XML into {filename}.drawio will be converted into an svg file.

You can include files for generation in your markdown using ![example.drawio](example.drawio)

Markdown / MkDocs / MkDocs-Material

MkDocs will index, provide search functionality and format your markdown documents into a website. Material for MkDocs is used to provide some extra bells and whistles

docker-drawio-mkdocs's People

Contributors

compatech avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

rgruyters mosibi

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.