skills.rest
javierhbr
javierhbrCOMMUNITY
Explore all skills by this author →
GitHub

exdoc-config

Configures ExDoc for Elixir projects via mix.exs project and docs functions.

Updated Feb 17, 2026
Search Tags:#developer tools#documentation#configuration#elixir#mix.exs#exdoc
One-click install
npx skills add https://github.com/javierhbr/random-poc --skill exdoc-config
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: exdoc-config
Source: https://github.com/javierhbr/random-poc/tree/main/custom-skills/beagle-main/plugins/beagle-elixir/skills/exdoc-config
Command: npx skills add https://github.com/javierhbr/random-poc --skill exdoc-config

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the process of configuring ExDoc for Elixir projects, ensuring your documentation is well-organized, searchable, and visually appealing.

Core Features & Use Cases

  • Comprehensive Configuration: Covers setting up mix.exs for ExDoc, including dependencies, project details, and the docs function.
  • Customization: Guides on managing extras (Markdown, cheatsheets, Livebooks), grouping modules and extras, and adding custom HTML/assets.
  • Use Case: When starting a new Elixir project or refactoring an existing one, use this Skill to quickly set up ExDoc with custom landing pages, organized module groups, and linked dependency documentation.

Quick Start

Use the exdoc-config skill to set up ExDoc for an Elixir project by adding the necessary configurations to mix.exs.

Frequently Asked Questions about exdoc-config

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure ExDoc in an Elixir mix.exs file?▼

Configure ExDoc in Elixir by defining the project/0 and docs/0 functions within mix.exs to manage main page, output format, and source reference settings, ensuring generated documentation is well-organized.

Can I add Markdown, cheatsheets, and Livebooks as ExDoc extras?▼

Yes, you can add Markdown, cheatsheets, and Livebooks as extras in ExDoc. The configuration in mix.exs allows you to include these additional formats to provide comprehensive guides alongside your generated module documentation.

How do I group modules and extras in Elixir documentation?▼

Group modules and extras in Elixir documentation by using the grouping options within the docs/0 function of your mix.exs file. This organizes your generated documentation into logical sections for easier navigation.

Does ExDoc support custom HTML injection and static asset inclusion?▼

Yes, ExDoc supports custom HTML injection and static asset inclusion. You can manage these settings through the docs/0 function in mix.exs to customize the visual layout and add necessary assets to your documentation output.

How do I link dependency documentation in an Elixir project?▼

Link dependency documentation in an Elixir project by configuring the dependency documentation links within the docs/0 function of mix.exs. This connects your generated docs to external library references for seamless browsing.

What is the best way to set a custom landing page and logo in ExDoc?▼

Set a custom landing page and logo in ExDoc by specifying the main page and logo path within the docs/0 function of mix.exs. This configuration directs users to a specific entry point and brands your documentation.

Related Skills

Explore More Software Engineering Skills→
jusi-devjusi-dev

hex-docs-search

Locate Elixir Hex package docs from local sources and HexDocs API.

Community
Intermediate
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
javierhbrjavierhbr

elixir-docs-review

Review Elixir documentation for ExDoc best practices and doctest correctness.

Community
Intermediate
fabioc-alohafabioc-aloha
1

API Documentation Skill

Scaffold technical documentation projects with templates for API endpoints and guides.

Community
Intermediate