search

nipy / mindboggle

Automated anatomical brain label/shape analysis software (+ website)
http://mindboggle.info
Other
145 stars 54 forks source link

uses .rst format for README #51

Closed jsalva closed 9 years ago

jsalva commented 9 years ago

So github formats the README appropriately

satra commented 9 years ago

@jsalva - could you please use md (markdown) instead of RST. even easier to do.

binarybottle commented 9 years ago

I have changed the README, LICENSE, STORY, THANKS, and LABELS to README.rst, etc. and now its formatting looks good not just on the website but on GitHub as well -- Thank you! However, how do you get links to work if those links are included in a separate file? For example, to build the website, I use ".. include:: doc/links.txt" at the bottom of .rst pages, but this doesn't work for GitHub. Should I put this links.txt file in http://mindboggle.info/ and include ".. include:: http://mindboggle.info/links.txt" at the bottom of these pages?

jsalva commented 9 years ago

seems they sandboxed markup formats to avoid .. include:: *-style directives for security reasons

https://github.com/github/markup/issues/172

binarybottle commented 9 years ago

Thank you, John! For now, I will remove .. include:: and simply include all links within each document.