#19846: Beautify README for plaintext to markdown for github
-------------------------------------+-------------------------------------
Reporter: karandesai-96 | Owner: karandesai-96
Type: enhancement | Status: needs_review
Priority: trivial | Milestone: sage-wishlist
Component: misc | Resolution:
Keywords: README, markdown, | Merged in:
github | Reviewers:
Authors: Karan Desai | Work issues:
Report Upstream: None of the above | Commit:
- read trac for reasoning. | 989d2fbabd061ac93b412254a6a253e3215b2752
Branch: | Stopgaps:
u/karandesai-96/beautify_readme |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by karandesai-96):
@nbruin:
README.md as a plaintext file looks like this :
https://raw.githubusercontent.com/karandesai-96/sage/t/19846/beautify_readme/README.md
where each line contains 80 characters or less.
Github renders this README.md by compiling it to html and displaying it
beautifully as:
https://github.com/karandesai-96/sage/tree/t/19846/beautify_readme
Anywhere else other than github (in text editors on local machine for
example), the README will appear as the first link and not the second one.
To create a new line in markdown, the plaintext version must have one
complete blank line between two lines, or a <br> tag written at the end of
each line. This will make the plaintext version of the file very lengthy
and containing too many blank lines or <br> tags at the end of each line.
Is it fine to have too many <br> tags in the README paintext version (as
per first link) ?
Please reply and I will take necessary actions.
--
Ticket URL: <http://trac.sagemath.org/ticket/19846#comment:7>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
