-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Import markdown spec under spec/ #3662
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
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
split into their own files
the original spec.
and a back-reference from the expressions chapter.
make examples and inline code look better.
- Style of examples elements changed to delineate grouped examples.
…ntal code for a fixed pop-out version of the table of contents, which is currently disabled.
second-pass review.
fix for grammar code block (duplicate style annotation)
removed LaTeX labels converted TODOs to comments
fixed math array for PDF output
fixed undefined macro
rendering on github) added note on todo command conversion
does not render in the PDF otherwise.
After some dirty grepping, regexing and perling, I present to you: internal links! I wish there was a way to make this more robust, these will only work on the html version, and assume we don't change filenames...
To mimic github flavored markdown for local viewing. Note that this requires a development version of jekyll.
with_toc_data was updated in vmg/redcarpet#186 to generate pretty ID attributes for Hn headers, which is what we use for cross-linking
Add chapter number to YAML, which is replace in numbering.css. Use CSS counters for chapters, sections, subsections | examples. Examples are detected by looking at the H3 element's id, which redcarpet derives from the heading's title. It must start with "Example:", and the whole title is suppressed by a little javascript, so we can make Examples look like in the pdf. For example, `### Example:` becomes `Example 3.2.10`, if it's the 10th example in Section 3.2.
To avoid confusion, removing artifacts for currently unsupported targets (pdf/single-page html). I'd like to bring those back, but in the mean time let's avoid distractions. Add Travis build.
The bulk of the effort was done in: https://github.com/iainmcgin/scala-ref-markdown/ I just ported it to redcarpet 3.1, added a jekyll build to run on Travis, and fixed some long-standing spec bugs. As described in spec/README.md, for now we're only generating an html page per each chapter with a rudimentary toc index. We'll focus on presenting this more nicely first, and then look into a pdf / single-page html version.
adriaanm
added a commit
that referenced
this pull request
Mar 28, 2014
Import markdown spec under spec/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The bulk of the effort was done in:
https://github.com/iainmcgin/scala-ref-markdown/ -- thanks, @iainmcgin!!
I just ported it to redcarpet 3.1, added a jekyll build to run on Travis,
and fixed some long-standing spec bugs.
As described in spec/README.md, for now we're only generating
an html page per each chapter with a rudimentary toc index.
We'll focus on presenting this more nicely first, and then
look into a pdf / single-page html version.
Signed off by @gkossakowski