Skip to content

Commit 68302e6

Browse files
Docs headings and changelog refactor (#5067)
* Changelog sub-sections should use h3, not h2; no need for hack anchor tag anymore * Internationalize dates to user’s locale * Consistent names * Split up the changelog into separate files per version; make HTML markup consistent with the other sections in the docs * Fix sidebar links for introduction and overview
1 parent 0e7677a commit 68302e6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+1485
-1215
lines changed

Cakefile

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -182,18 +182,10 @@ buildDocs = (watch = no) ->
182182

183183
# Helpers
184184
releaseHeader = (date, version, prevVersion) ->
185-
monthNames = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
186-
187-
formatDate = (date) ->
188-
date.replace /^(\d\d\d\d)-(\d\d)-(\d\d)$/, (match, $1, $2, $3) ->
189-
"#{monthNames[$2 - 1]} #{+$3}, #{$1}"
190-
191185
"""
192-
<div class="anchor" id="#{version}"></div>
193-
<h2 class="header">
194-
#{prevVersion and "<a href=\"https://github.com/jashkenas/coffeescript/compare/#{prevVersion}...#{version}\">#{version}</a>" or version}
195-
<span class="timestamp"> &mdash; <time datetime="#{date}">#{formatDate date}</time></span>
196-
</h2>
186+
<h3>#{prevVersion and "<a href=\"https://github.com/jashkenas/coffeescript/compare/#{prevVersion}...#{version}\">#{version}</a>" or version}
187+
<span class="timestamp"> &mdash; <time datetime="#{date}">#{date}</time></span>
188+
</h3>
197189
"""
198190

199191
codeFor = require "./documentation/site/code.coffee"
@@ -224,7 +216,7 @@ buildDocs = (watch = no) ->
224216
"<blockquote class=\"uneditable-code-block\">#{defaultFence.apply @, arguments}</blockquote>"
225217

226218
(file, bookmark) ->
227-
md = fs.readFileSync "#{sectionsSourceFolder}/#{file}.md", 'utf-8'
219+
md = fs.readFileSync "#{sectionsSourceFolder}/#{file.replace /\//g, path.sep}.md", 'utf-8'
228220
md = md.replace /<%= releaseHeader %>/g, releaseHeader
229221
md = md.replace /<%= majorVersion %>/g, majorVersion
230222
md = md.replace /<%= fullVersion %>/g, CoffeeScript.VERSION

docs/v2/index.html

Lines changed: 537 additions & 448 deletions
Large diffs are not rendered by default.

documentation/sections/changelog.md

Lines changed: 0 additions & 750 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 10 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 10 additions & 0 deletions
Lines changed: 6 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 6 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 7 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
Lines changed: 5 additions & 0 deletions

0 commit comments

Comments
 (0)