Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swedbankpay/jekyll-plantuml-docker
Docker image for Jekyll with PlantUML diagram support
https://github.com/swedbankpay/jekyll-plantuml-docker
docker docker-image jekyll plantuml
Last synced: about 2 months ago
JSON representation
Docker image for Jekyll with PlantUML diagram support
- Host: GitHub
- URL: https://github.com/swedbankpay/jekyll-plantuml-docker
- Owner: SwedbankPay
- License: apache-2.0
- Created: 2020-04-28T07:52:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-11T02:33:24.000Z (11 months ago)
- Last Synced: 2024-02-11T03:25:54.345Z (11 months ago)
- Topics: docker, docker-image, jekyll, plantuml
- Language: Ruby
- Homepage: https://hub.docker.com/r/swedbankpay/jekyll-plantuml
- Size: 1.44 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Jekyll PlantUML
![Test][test-badge]
[![codecov][codecov-badge]][codecov]
[![Codacy Grade][codacy-badge]][codacy]
[![Docker Pulls][docker-pull-badge]][docker]
[![Docker Image Version (latest semver)][docker-version-badge]][docker]
[![CLA assistant][cla-badge]][cla]
[![Contributor Covenant][coc-badge]][coc]
[![License][license-badge]][license]
This is the repositry for the [`swedbankpay/jekyll-plantuml`][docker] Docker
image. The purpose of the image is to have a shared Docker image to run
[Jekyll][jekyll] sites with [PlantUML][plantuml] support (via the
[kramdown-plantuml][kramdown-plantuml] Ruby Gem).
## Usage
### Commands
The Docker image is outfitted with an [`entrypoint`][entrypoint] that allows you
to run a few commands inside the container. these commands are described below.
#### Serve
To have Jekyll serve content from the current working directory, simply execute
the following:
```bash
docker run --tty --volume $(pwd):/srv/jekyll swedbankpay/jekyll-plantuml:latest serve
```
#### Build
To build the content in the current working directory and have the results spit
out to a `_site` sub-directory, execute the following:
```bash
docker run --tty --volume $(pwd):/srv/jekyll swedbankpay/jekyll-plantuml:latest build
```
The `build` command also takes an argument:
##### `--verify`
Verifies that the built HTML is valid using [HTMLProofer][html-proofer].
#### Deploy
There is also a special `deploy` command which will execute [Git Directory
Deploy][gdd] in order to perform a `jekyll build` and then deploy the resulting
HTML to the `gh-pages` branch (by default):
```shell
docker run --tty \
--volume $(pwd):/srv/jekyll \
--env GIT_DEPLOY_REPO="${GIT_DEPLOY_REPO}" \
--env GIT_DEPLOY_BRANCH="${GIT_DEPLOY_BRANCH}" \
swedbankpay/jekyll-plantuml:latest \
deploy
```
The `deploy` command takes the following environment variables:
##### `GIT_DEPLOY_REPO`
**Required**. The URL of the repository to deploy (`git push`) to. Must include
a [Personal Access Token][pat] in the URL as such:
```bash
https://${{ secrets.GH_PAGES_TOKEN }}@github.com/${{ github.repository }}.git
```
##### `GIT_DEPLOY_BRANCH`
**Optional**. The branch to deploy to. Default `gh-pages`.
The `deploy` command also takes arguments:
##### `--dry-run`
Performs a full deployment, but doesn't push the results to the remote `origin`.
### Volume
The Docker image exposes one volume: **`/srv/jekyll`**. Map this to the local
directory you want Jekyll to use as its source content directory for `jekyll
build`, `jekyll serve`, etc. Simply put, this is where your `.md` files are
placed.
### Configuration
While it is highly recommended to [install Jekyll][jekyll-docs] locally and
initialize a Jekyll site with `jekyll new `, this is not required to
serve or convert `.md` files with `jekyll-plantuml`.
This is achieved by shipping a [default `Gemfile`][gemfile] and [default
`_config.default.yml`][config] with the Docker container that is used in the
case that a `Gemfile` and/or `_config.yml` file can't be found locally.
If you want a full Jekyll site with local config, custom plugins, etc., you need
to install Jekyll and initialize the folder you `build` or `serve` with it
according to [Jekyll's documentation][jekyll-docs].
## Contributing
Bug reports and pull requests are welcome on [GitHub][github]. This project is
intended to be a safe, welcoming space for collaboration, and contributors are
expected to adhere to the [code of conduct][coc] and sign the
[contributor's license agreement][cla].
## License
The code within this repository is available as open source under the terms of
the [Apache 2.0 License][license] and the [contributor's license
agreement][cla].
[cla-badge]: https://cla-assistant.io/readme/badge/SwedbankPay/jekyll-plantuml-docker
[cla]: https://cla-assistant.io/SwedbankPay/jekyll-plantuml-docker
[coc-badge]: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
[coc]: ./CODE_OF_CONDUCT.md
[codacy-badge]: https://app.codacy.com/project/badge/Grade/05ad4e8db4fc47d09e24c3a01b2f1b53
[codacy]: https://www.codacy.com/gh/SwedbankPay/jekyll-plantuml-docker?utm_source=github.com&utm_medium=referral&utm_content=SwedbankPay/jekyll-plantuml-docker&utm_campaign=Badge_Grade
[codecov-badge]: https://codecov.io/gh/SwedbankPay/jekyll-plantuml-docker/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/SwedbankPay/jekyll-plantuml-docker
[config]: ./.docker/entrypoint/_config.default.yml
[docker-pull-badge]: https://img.shields.io/docker/pulls/swedbankpay/jekyll-plantuml
[docker-version-badge]: https://img.shields.io/docker/v/swedbankpay/jekyll-plantuml
[docker]: https://hub.docker.com/r/swedbankpay/jekyll-plantuml
[entrypoint]: ./.docker/entrypoint
[gdd]: https://github.com/SwedbankPay/git-directory-deploy/
[gemfile]: ./.docker/entrypoint/Gemfile
[github]: https://github.com/SwedbankPay/jekyll-plantuml-docker
[html-proofer]: https://github.com/gjtorikian/html-proofer
[jekyll-docs]: https://jekyllrb.com/docs/
[jekyll]: https://jekyllrb.com/
[kramdown-plantuml]: https://github.com/SwedbankPay/kramdown-plantuml
[license-badge]: https://img.shields.io/github/license/SwedbankPay/jekyll-plantuml-docker
[license]: https://opensource.org/licenses/Apache-2.0
[pat]: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
[plantuml]: https://plantuml.com/
[test-badge]: https://github.com/SwedbankPay/jekyll-plantuml-docker/workflows/Test/badge.svg