Skip to content

Conversation

@milmazz
Copy link
Member

@milmazz milmazz commented Sep 12, 2015

This PR allows the user to include additional Markdown pages, via command line you can use as many --extra (or the alias -e) as you want:

$ bin/elixir ../ex_doc/bin/ex_doc "EEx" "1.1.0-beta" "lib/eex/ebin" -m "EEx" -u "https://github.com/elixir-lang/elixir" --source-ref "64bb812f15e8b9ec078f76cfd8e26578bf2ddaa0"  -o doc/eex -p http://elixir-lang.org/docs.html \
--readme README.md -e CHANGELOG.md -e CONTRIBUTING.md

$ ls doc/eex/{README,CHANGELOG,CONTRIBUTING}.html         
doc/eex/CHANGELOG.html doc/eex/CONTRIBUTING.html doc/eex/README.html

For Mix there is a new options called extras:, example:

# file: mix.exs
docs: [source_ref: "v#{@version}", main: "Ecto",
            source_url: "https://github.com/elixir-lang/ecto",
            readme: "README.md", extras: ["CHANGELOG.md"]]]

Closes #316

/cc @josevalim @dignifiedquire

@dignifiedquire
Copy link
Contributor

Love it, even styling wise I think this is good for now!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can deprecate it now. We are before 1.0. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, just remove it.

@josevalim
Copy link
Member

AWesome work @milmazz! I have added two comments, feel free to remove the README option, and let's ship it!

milmazz added a commit that referenced this pull request Sep 13, 2015
Allow users to include additional Markdown pages
@milmazz milmazz merged commit cf292ea into master Sep 13, 2015
@milmazz milmazz deleted the issue_316 branch September 13, 2015 08:48
@lpil
Copy link

lpil commented Sep 13, 2015

Yay!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants