https://github.com/suecodelabs/docker-drawio-mkdocs

https://github.com/suecodelabs/docker-drawio-mkdocs

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/suecodelabs/docker-drawio-mkdocs
• Owner: suecodelabs
• License: mit
• Created: 2021-03-09T14:23:58.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-20T11:18:38.000Z (over 3 years ago)
• Last Synced: 2023-03-06T05:15:30.858Z (almost 2 years ago)
• Language: Shell
• Size: 24.4 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://www.mkdocs.org) documentation, written in markdown and including generated [drawio](https://draw.io) 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](https://draw.io) 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](https://www.mkdocs.org) will index, provide search functionality and format your [markdown](https://www.markdownguide.org) documents into a website. [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) is used to provide some extra bells and whistles