- Notifications
You must be signed in to change notification settings - Fork2
Elixir Mix task for pushing documentation to github pages
License
NotificationsYou must be signed in to change notification settings
jjh42/docs_ghpages
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
This is a small library to add an extra task to the Elixirmix
tooldocs.ghpages
. This will build the docs and push themto the branchgh-pages
of theorigin
git remote.
This is useful if you are hosting your Elixir app or library on githubas this will publish the documentation on thegithub pagesfor your repo.
Note that the documents are removed, rebuilt from scratch and pushedwith--force
to thegh-pages
so any changes inside thedocs
folderwill be destroyed (which is usually fine if you're autogenerating thedocs
).
Open an issue.