Skip to content

Docs: Include more files, add ex_doc as a direct dependency#513

Merged
RobertDober merged 2 commits intopragdave:masterfrom
adamu:main
Jun 21, 2025
Merged

Docs: Include more files, add ex_doc as a direct dependency#513
RobertDober merged 2 commits intopragdave:masterfrom
adamu:main

Conversation

@adamu
Copy link
Contributor

@adamu adamu commented Apr 26, 2025

I was reading the docs for this project on Hexdocs, but I missed out on some information, as the useful info in the README is only in the repo, not the compiled docs.

This PR adds the README.md and RELEASE.md files to the compiled docs, and makes the README, rather than the Earmark module, the first page when visiting the docs.

image

Additionally, as ExDoc no longer depends on this project, it's possible to use ExDoc directly here, which I did and removed the ex_doc escript.

@adamu adamu changed the title Include README.md & RELEASE.md files in docs, make README first page Docs: Include more files, add ex_doc as a direct dependency May 30, 2025
@crertel
Copy link

crertel commented May 30, 2025

I'm not sure why ex_doc wasn't in as a dep, but I think it might be because ex_doc uses earmark internally, no?

@adamu
Copy link
Contributor Author

adamu commented May 30, 2025

I'm not sure why ex_doc wasn't in as a dep, but I think it might be because ex_doc uses earmark internally, no?

ExDoc used to use the Earmark.Parser module from this project - but that was forked to its own package which ExDoc now uses, so it's possible to use ExDoc directly here (but not in :earmark_parser).

@RobertDober
Copy link
Collaborator

@crertel you are right that was the reason and @adamu corrected it \o/

@RobertDober RobertDober merged commit bc03826 into pragdave:master Jun 21, 2025
4 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants