# How to link to the repo's NEWS.md in the documentation?

**URL:** <https://discourse.julialang.org/t/how-to-link-to-the-repos-news-md-in-the-documentation/47477>\
**Category:** General Usage\
**Tags:** question, documentation\
**Created:** [September 29, 2020, 8:51am UTC](https://discourse.julialang.org/t/how-to-link-to-the-repos-news-md-in-the-documentation/47477 "2020-09-29T08:51:14Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![jishnub](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/jishnub/32/33620_2.png) [@jishnub](https://discourse.julialang.org/u/jishnub)\
**Post date:** [September 29, 2020, 8:51am UTC](https://discourse.julialang.org/t/how-to-link-to-the-repos-news-md-in-the-documentation/47477/1 "2020-09-29T08:51:14Z")

</div>

I notice that the link to “news” in the [documentation](http://juliamath.github.io/Interpolations.jl/latest/) for `Interpolations.jl` is broken. Currently the link points to `../../NEWS.md`. Given the directory structure `docs/src/index.md`, this appears to be the correct relative link. However the link generated in the documentation appears to be “[http://juliamath.github.io/NEWS.md](http://juliamath.github.io/NEWS.md)”. How can this be fixed?

---

<div class="post-metadata">

**Author:** ![mortenpi](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mortenpi/32/158_2.png) [@mortenpi](https://discourse.julialang.org/u/mortenpi)\
**Post date:** [September 29, 2020, 9:28pm UTC](https://discourse.julialang.org/t/how-to-link-to-the-repos-news-md-in-the-documentation/47477/2 "2020-09-29T21:28:30Z")

</div>

Documenter only recognizes the Markdown pages that are under `docs/src`, and relative links pointing outside of `src/` do not work. However, what you can do it just `cp` the `NEWS.md` file over to `src/` in `make.jl` before you run `makedocs` and then refer to it as if it’s under `src/`.

---

<div class="post-metadata">

**Author:** ![jishnub](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/jishnub/32/33620_2.png) [@jishnub](https://discourse.julialang.org/u/jishnub)\
**Post date:** [September 30, 2020, 6:08am UTC](https://discourse.julialang.org/t/how-to-link-to-the-repos-news-md-in-the-documentation/47477/3 "2020-09-30T06:08:27Z")

</div>

Thanks, this sounds like a good idea. Would a symlink work as well? Or should I copy the actual file? Does github pages support symlinks?

---

<div class="post-metadata">

**Author:** ![jgreener64](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/jgreener64/32/2483_2.png) [@jgreener64](https://discourse.julialang.org/u/jgreener64)\
**Post date:** [September 30, 2020, 9:23am UTC](https://discourse.julialang.org/t/how-to-link-to-the-repos-news-md-in-the-documentation/47477/4 "2020-09-30T09:23:19Z")

</div>

Yes, symlinks work and work with GitHub pages. Saves you copying the file every time.

I use this to copy the README into the docs in BioStructures.jl: [https://github.com/BioJulia/BioStructures.jl/tree/master/docs/src](https://github.com/BioJulia/BioStructures.jl/tree/master/docs/src).