remark-frontmatter-starter
Val Town is a collaborative website to build and scale JavaScript apps.
Deploy APIs, crons, & store data – all from the browser, and deployed in milliseconds.
Viewing readonly version of main branch: v490View latest version
This plan addresses refactoring, cleanup, organization, and key design principles (KISS, YAGNI, SoC, SRP, DRY) with beginner‑friendly names.
-
Reorganize code modules
- src/parser.ts → unified parser setup
- src/builders/navigation.ts → buildNav (doc links + sidebar)
- src/builders/head.ts → buildHead
- src/builders/scripts.ts → buildScripts (client interactivity)
- src/utils.ts → loadDoc, groupByFolder, buildToc
- src/config.ts → central config + docs list
- src/handlers.ts → appHandler (handleRequest + renderDoc)
-
Centralize CSS URLs
- Create helper in config.ts to resolve all stylesheet paths once
-
Remove unneeded runtime plugins
- Drop remarkLint (move to dev chain)
-
Rename for brevity & clarity
- docLinksHtml → buildNav
- sidebarHtml → buildSidebar
- generateTableOfContents → buildToc
- groupDocsByFolder → groupByFolder
- processDocument → renderDoc
- handleRequest → appHandler
-
Clean up
- Delete empty folders (src/client, src/server)