skills.rest
Krastanov
KrastanovCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

julia-docs

Generate Julia package documentation websites with Documenter.jl.

30|6|Updated Jan 21, 2026
Search Tags:#documentation#build process#api reference#julia#package development#documenter.jl
One-click install
npx skills add https://github.com/Krastanov/JuliaLLMAgentSkills --skill julia-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: julia-docs
Source: https://github.com/Krastanov/JuliaLLMAgentSkills/tree/main/julia-docs
Command: npx skills add https://github.com/Krastanov/JuliaLLMAgentSkills --skill julia-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps you set up and build documentation websites for your Julia packages, ensuring your project is well-documented and discoverable.

Core Features & Use Cases

  • Documentation Generation: Uses Documenter.jl to create professional documentation sites.
  • Configuration: Provides guidance on setting up docs/Project.toml and docs/make.jl.
  • Local Building: Shows how to build documentation locally for preview.
  • Use Case: You've just finished developing a new Julia package and need to create a user-friendly documentation website to explain its features and API.

Quick Start

Run julia -tauto --project=docs docs/make.jl to build your documentation locally.

Frequently Asked Questions about julia-docs

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

FAQPage Schema
How do I build documentation for a Julia package using Documenter.jl?▼

To build Julia package documentation, configure the `docs/make.jl` build script and run `julia -tauto --project=docs docs/make.jl` to generate the site locally. This process uses Documenter.jl to render pages.

What files do I need to set up to generate Julia package documentation?▼

You need to set up a `docs/Project.toml` for environment management and a `docs/make.jl` configuration file. These files define dependencies and instruct Documenter.jl to build documentation pages.

Can I preview my Julia documentation site locally before publishing?▼

Yes, you can preview Julia documentation locally by executing the build script. Running `julia -tauto --project=docs docs/make.jl` generates the site files on your machine for immediate local review.

Why do I need Documenter.jl for Julia package development?▼

Documenter.jl is needed to transform code and markdown into a searchable documentation website. It generates API references and guides, addressing the need for clear, accessible project documentation in the Julia ecosystem.

Does this documentation build process handle API reference generation automatically?▼

Yes, the documentation build process handles API reference generation. By configuring `make.jl` with Documenter.jl, the system automatically extracts docstrings to create structured API reference pages.

Related Skills

Explore More Software Engineering Skills→
KrastanovKrastanov
30

julia-package-dev

Manage Julia package environments with live code reloading via Revise.jl.

Community
Intermediate
brainbrewlabsbrainbrewlabs
7

doc-publishing

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

Official
Intermediate
KrastanovKrastanov
30

julia-multipackage

Manage dependencies and test multiple interdependent Julia packages in a shared environment.

Community
Intermediate
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate