Skip to content

A container to expose your Markdown-based project documentation with Raneto.

License

Notifications You must be signed in to change notification settings

francescoben/docker-node-raneto

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Raneto Docker image

A container to expose your Markdown-based project documentation with Raneto.

While a Raneto base image is available at the time of writing (https://github.com/chanux/docker-raneto) I felt like creating my own so that:

  • It was based on official Node images (node, npm and other tools already there). I used slim to keep things lightweight.
  • The container was exposing a local docs folder via Raneto, so that I can use the same image on different projects with docker-compose.

Content

The last version of this image is based on Node 6.1.0-slim image, with global gulp-cli and a modified version of Raneto 0.9.0.

Usage

This image works mounting a local documentation folder in a volume inside the container, and exposing Raneto on port 80. It also supports a custom configuration file for Raneto.

To run the image mounting only documentation's folder issue:

docker run -p 80:80 -v </path/to/your/content>:/srv/raneto/content -d francescoben/docker-node-raneto

To run the image with documentation's folder and a custom config file issue:

docker run -p 80:80 -v </path/to/your/content-folder>:/srv/raneto/content -v </path/to/your/config-file>:/srv/raneto/config.js -d francescoben/docker-node-raneto

You can then browse your content visiting:

http://localhost:80

Contributions and todo

  • PRs are welcome, I'll try to review them as quickly as possible.
  • Currently only standard theme is available in the image. Being able to dinamically read new themes from local volume would be great. Same as above.

Credits

Thanks to my colleague Paolo Pustorino who helped me to improve his version of this Docker Image SparkFabrik Raneto Docker image.

About

A container to expose your Markdown-based project documentation with Raneto.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published