Skip to content

Conversation

@adriaanm
Copy link
Contributor

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

and a back-reference from the expressions chapter.
- 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.
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
adriaanm added 26 commits March 13, 2014 11:19
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/
@adriaanm adriaanm merged commit bd9cde4 into master Mar 28, 2014
@adriaanm adriaanm deleted the spec branch March 28, 2014 17:39
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.

8 participants