Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

uses .rst format for README #51

Closed
wants to merge 2 commits into from
Closed

uses .rst format for README #51

wants to merge 2 commits into from

Conversation

jsalva
Copy link

@jsalva jsalva commented Jan 27, 2015

So github formats the README appropriately

@satra
Copy link
Member

satra commented Jan 27, 2015

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

@binarybottle
Copy link
Member

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
Copy link
Author

jsalva commented Jan 28, 2015

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

github/markup#172

@binarybottle
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants