Skip to content

DavidOliver/ex_doc-env

Repository files navigation

ExDoc env

A Devbox environment for ExDoc.

Setup

ExDoc is added as a Git submodule. To checkout the submodule when cloning:

$ git clone --recurse-submodules git@github.com:DavidOliver/ex_doc-env.git

You can subsequently add your own fork of ExDoc as a remote from within the ex_doc directory.

$ cd ex_doc
$ git remote add <name> <url>

Usage

Launch the environment:

$ devbox shell

Develop ExDoc as usual:

(devbox) $ cd ex_doc
(devbox) $ mix setup
(devbox) $ mix build
(devbox) $ npm run --prefix assets build:watch

The built documentation resides in the ex_doc/doc directory.

To make the built documentation available to other devices at port 8082:

(devbox) $ devbox services up

About

A Devbox environment for Elixir's ExDoc

Topics

Resources

Stars

Watchers

Forks