https://github.com/andyneff/docker-github-markdown-preview
Docker to call github-markdown-preview
https://github.com/andyneff/docker-github-markdown-preview
Last synced: about 1 month ago
JSON representation
Docker to call github-markdown-preview
- Host: GitHub
- URL: https://github.com/andyneff/docker-github-markdown-preview
- Owner: andyneff
- License: mit
- Created: 2017-06-21T20:19:10.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-21T20:30:01.000Z (about 9 years ago)
- Last Synced: 2025-12-03T02:14:59.077Z (7 months ago)
- Language: Ruby
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-markdown-preview
Docker to run github-markdown-preview with syntax highlighting installed.
## Usage
Converts all images in current directory (using a script called `github-markdown-render`)
```
USER_ID=`id -u` GROUP_ID=`id -g` \
docker-compose run github-markdown-preview
```
Convert all images in another directory
```
USER_ID=`id -u` GROUP_ID=`id -g` SRC_DIR={some_other_dir} OUT_DIR={some_other_dir}\
docker-compose run github-markdown-preview
```
Convert images in a dir without docker-compose
```
docker run -it --rm -e DOCKER_USER_ID=`id -u` -e DOCKER_GROUP_ID=`id -g` \
-v {markdown_dir}:/src:ro -v {output_dir}:/out \
andyneff/github-markdown-preview
```
Call the original `github-markdown-preview` program
```
USER_ID=`id -u` GROUP_ID=`id -g` \
docker-compose run github-markdown-preview github-markdown-preview /out/README.md
```
## Known bugs
It currently prints out the harmless warning:
```
/usr/local/bundle/gems/nokogiri-1.6.5/lib/nokogiri/html/document.rb:164: warning: constant ::Fixnum is deprecated
/usr/local/bundle/gems/nokogiri-1.6.5/lib/nokogiri/xml/node.rb:521: warning: constant ::Fixnum is deprecated
```
## References
- [Original image](https://github.com/docker-rubygem/github-markdown-preview)