gtfs-to-html 2.6.1 → 2.6.2

package/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.6.2] - 2024-04-19
+
+### Updated
+- Dependency updates
+- Update to timetable page sorting
+
+### Added
+
+- Markdown support in timetable notes
+
 ## [2.6.1] - 2024-03-26
 
 ### Fixed

package/examples/timetable_notes.txt

@@ -4,4 +4,5 @@ note_id,symbol,note
 3,,"Trip is cancelled if drawbridge is up"
 4,,"This stop is sometimes underwater"
 5,,"Driver will only stop if prearranged by fax"
-6,§,"Vehicle can arrive early if leap second is added during trip"
+6,§,"Vehicle can arrive early if leap second is added during trip and *will not wait*"
+7,,"[See list of holidays](http://transitagency.org/holidays)"

package/examples/timetable_notes_references.txt

@@ -5,3 +5,4 @@ note_id,timetable_id,route_id,trip_id,stop_id,stop_sequence,show_on_stoptime
 4,,,,254514,,
 5,,,,254514,11,
 6,,,17010,235269,,
+7,131,,,,,

package/lib/file-utils.js

@@ -11,6 +11,8 @@ import { renderFile } from 'pug';
 import puppeteer from 'puppeteer';
 import sanitize from 'sanitize-filename';
 import untildify from 'untildify';
+import insane from 'insane';
+import { marked } from 'marked';
 
 import {
   isNullOrEmpty,
@@ -169,9 +171,10 @@ export function generateFolderName(timetablePage) {
 export async function renderTemplate(templateFileName, templateVars, config) {
   const templatePath = getTemplatePath(templateFileName, config);
 
-  // Make template functions and lodash available inside pug templates.
+  // Make template functions, lodash and marked available inside pug templates.
   const html = await renderFile(templatePath, {
     _,
+    md: (text) => insane(marked.parseInline(text)),
     ...templateFunctions,
     formatRouteColor,
     formatRouteTextColor,

package/lib/utils.js

@@ -1612,17 +1612,24 @@ export function generateOverviewHTML(timetablePages, config) {
   // Sort timetables for display, first numerically then alphabetically.
   const sortedTimetablePages = sortBy(timetablePages, [
     (timetablePage) => {
+      // First sort numerically by route_short_name, removing leading non-digits
       if (
         timetablePage.consolidatedTimetables.length > 0 &&
         timetablePage.consolidatedTimetables[0].routes.length > 0
       ) {
-        return Number.parseInt(
-          timetablePage.consolidatedTimetables[0].routes[0].route_short_name,
-          10,
+        return (
+          Number.parseInt(
+            timetablePage.consolidatedTimetables[0].routes[0].route_short_name?.replace(
+              /^\D+/g,
+              '',
+            ),
+            10,
+          ) || 0
         );
       }
     },
     (timetablePage) => {
+      // Then sort by route_short_name alphabetically
       if (
         timetablePage.consolidatedTimetables.length > 0 &&
         timetablePage.consolidatedTimetables[0].routes.length > 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtfs-to-html",
-  "version": "2.6.1",
+  "version": "2.6.2",
   "private": false,
   "description": "Build human readable transit timetables as HTML, PDF or CSV from GTFS",
   "keywords": [
@@ -42,14 +42,16 @@
     "copy-dir": "^1.3.0",
     "csv-stringify": "^6.4.6",
     "express": "^4.19.2",
-    "gtfs": "^4.9.0",
+    "gtfs": "^4.10.2",
+    "insane": "^2.6.2",
     "js-beautify": "^1.15.1",
     "lodash-es": "^4.17.21",
+    "marked": "^12.0.2",
     "moment": "^2.30.1",
     "morgan": "^1.10.0",
     "pretty-error": "^4.0.0",
     "pug": "^3.0.2",
-    "puppeteer": "^22.6.1",
+    "puppeteer": "^22.6.5",
     "sanitize-filename": "^1.6.3",
     "sqlstring": "^2.3.3",
     "timer-machine": "^1.1.0",

package/views/default/timetablepage.pug

@@ -54,7 +54,10 @@ include formatting_functions.pug
               if timetable.interpolatedStopSymbolUsed
                 .note(id=`note-${timetable.timetable_id}-interpolated-stop`)= `${config.interpolatedStopSymbol} = ${config.interpolatedStopText}`
               each note in _.uniqBy(timetable.notes, 'note_id')
-                .note(id=`note-${timetable.timetable_id}-${note.note_id}`)= `${note.symbol} = ${note.note}`
+                .note(id=`note-${timetable.timetable_id}-${note.note_id}`)
+                  span= note.symbol 
+                  span  = 
+                  span!= md(note.note)
 
           if config.showCalendarExceptions && timetable.calendarDates.includedDates.length
             .included-dates= `${config.serviceProvidedOnText}: ${timetable.calendarDates.includedDates.join(', ')}`

package/www/docs/additional-files.md

@@ -13,7 +13,7 @@ By default, GTFS-to-HTML attempts to generate a timetable for each route and dir
 * [timetable_pages.txt](/docs/timetable-pages) - Specifies which HTML timetables should be grouped together into a single HTML page.
 
 ## Adding notes to timetables
-Notes about a specific trip, stop, stoptime, route or timetable can be added to timetables by using `timetable_notes.txt` and `timetable_notes_references.txt` in your GTFS.
+Notes about a specific trip, stop, stoptime, route or timetable can be added to timetables by using `timetable_notes.txt` and `timetable_notes_references.txt` in your GTFS. These notes can include links and other formatting using Markdown syntax.
 
 * [timetable_notes.txt](/docs/timetable-notes) - Specifies notes to be used in timetables.
 * [timetable_notes_references.txt](/docs/timetable-notes-references) - Specifies where notes should be placed in timetables.

package/www/docs/timetable-notes.md

@@ -15,7 +15,7 @@ Notes can have a `symbol` specified or can be left blank and GTFS-to-HTML will a
 | ----------- | ----------- |
 | `note_id` | A unique ID for the timetable note |
 | `symbol` | The symbol used to indicate the note, such as `§`. Optional, if omitted a letter of the alphabet starting with `a` will be used. |
-| `note` | The text of the note, such as "This stop is sometimes underwater". |
+| `note` | The text of the note, such as "This stop is sometimes underwater". [Markdown syntax](https://daringfireball.net/projects/markdown/syntax) is supported which allows including links and formatting. |
 
 ### Example
 
@@ -26,7 +26,8 @@ note_id,symbol,note
 3,,"Trip is cancelled if drawbridge is up"
 4,,"This stop is sometimes underwater"
 5,,"Driver will only stop if prearranged by fax"
-6,§,"Vehicle can arrive early if leap second is added during trip"
+6,§,"Vehicle can arrive early if leap second is added during trip and *will not wait*"
+7,,"[See list of holidays](http://transitagency.org/holidays)"
 ```
 
 An example of this file is located in [examples/timetable_notes.txt](https://github.com/BlinkTagInc/gtfs-to-html/blob/master/examples/timetable_notes.txt).

package/www/package.json

@@ -9,8 +9,8 @@
     "deploy": "docusaurus deploy"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.1.1",
-    "@docusaurus/preset-classic": "^3.1.1",
+    "@docusaurus/core": "^3.2.1",
+    "@docusaurus/preset-classic": "^3.2.1",
     "clsx": "^2.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"