https://github.com/davidoliver/ex_doc-env

A Devbox environment for Elixir's ExDoc
https://github.com/davidoliver/ex_doc-env

elixir elixir-lang

Last synced: 7 months ago
JSON representation

A Devbox environment for Elixir's ExDoc

• Host: GitHub
• URL: https://github.com/davidoliver/ex_doc-env
• Owner: DavidOliver
• Created: 2023-10-16T19:18:13.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-26T14:54:41.000Z (over 1 year ago)
• Last Synced: 2025-02-12T07:06:08.379Z (over 1 year ago)
• Topics: elixir, elixir-lang
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ExDoc env

A [Devbox](https://www.jetpack.io/devbox/) environment for [ExDoc](https://hexdocs.pm/ex_doc/readme.html).

## 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  

## 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