Skip to content

Elixir Mix task for pushing documentation to github pages

License

Notifications You must be signed in to change notification settings

Baishan/docs_ghpages

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docs.ghpages

This is a small library to add an extra task to the Elixir mix tool docs.ghpages. This will build the docs and push them to the branch gh-pages of the origin git remote.

This is useful if you are hosting your Elixir app or library on github as this will publish the documentation on the github pages for your repo.

Note that the documents are removed, rebuilt from scratch and pushed with --force to the gh-pages so any changes inside the docs folder will be destroyed (which is usually fine if you're autogenerating the docs).

Help

Open an issue.

About

Elixir Mix task for pushing documentation to github pages

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Elixir 100.0%