top_level_readme - add option to hardcode branch used for GitHub links #8

norton opened this Issue Oct 9, 2011 · 2 comments


None yet

2 participants


I'd like to have an option added to the top_level_readme to allow hardcoding of the branch (namely the "master" branch) used for GitHub links. This would make pulling in changes from other branches to the master branch easier to manage.

%% Erlang edoc options
{edoc_opts, [{doclet, edown_doclet}
, {src_path, ["src", "test"]}
, {title, "Universal Binary Format"}
, {top_level_readme, {"./", ""}}


I have added support for this in the latest commit

Let me know if this is what you wanted (or not).


Yes, thank you. This change works well.

@norton norton closed this Mar 26, 2013
@tatsuya6502 tatsuya6502 pushed a commit to hibari/asciiedoc that referenced this issue Dec 31, 2013
@norton norton Add support for naming branch for top_level_README
See esl/edown#8 for details.
@tatsuya6502 tatsuya6502 pushed a commit to hibari/edown that referenced this issue Dec 31, 2013
@uwiger uwiger Experimental: Add option to name branch for top_level_README
See esl#8

If {top_level_readme, {Path, URL, Branch}} is specified, edown will
use Branch instead of deriving the current branch when linking to
the top-level README file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment