@@ -5,6 +5,24 @@ The following is a collection of thoughts, ideas and plans we've gone through
55in the last year or so. I wanted to try to get this "down on paper" to make it
66easier to discuss...
77
8+ Here's the TLDR; in terms of actual blocking TODOs if we wanted to stick with
9+ this branch:
10+
11+ - [ ] Finish porting the markdown process to ` remark ` (may require new plugins)
12+ - [ ] Extract anchors into ` _content.json ` via ` DirectoryTreePlugin `
13+ - [ ] Add custom route for landing page
14+ - [ ] Finish ` Navigation ` component (e.g. certain links are still excluded)
15+ - [ ] Rethink external population process
16+ - [ ] Finish re-incorporating mobile sidebar
17+ - [ ] Re-integrate google-analytics
18+ - [ ] Populate page title in ` server.jsx `
19+ - [ ] Re-incorporate redirects (` redirects.json ` )
20+
21+ Some of these should be fairly quick adds now that the site works. The two
22+ toughest ones are most likely the markdown parsing and external population. The
23+ thing to keep in mind with those two however is that they're going to be an
24+ issue no matter what our build system is. The following section
25+
826
927## Markdown Processing
1028
@@ -18,7 +36,6 @@ https://github.com/webpack-contrib/webpack-defaults/issues/73
1836We do have a bunch of custom ` markdown ` processing, however for a bunch of it
1937` remark ` plugins already exist:
2038
21- - ` remark-collapse `
2239- ` remark-autolink-headings `
2340- ` remark-mermaid ` (#469 )
2441- ` remark-highlight.js ` (though we do have a custom prism theme)
@@ -27,9 +44,14 @@ And here's what isn't covered yet (though probably could be with new plugins
2744and help from __ @wooorm__ ):
2845
2946- Mobile table customizations
30- - Code with links and collapsible sections
47+ - Code with links and collapsible sections ( ` <details> ` )
3148- Custom blockquotes (i.e. ` T> ` , ` W> ` , and ` ?> ` )
3249
50+ I think we may want to rethink some of this though. For example, is it 100%
51+ necessary for us to support inline linking and collapsing within code? There
52+ might be other ways to lay out those sections that don't require advanced
53+ parsing behavior.
54+
3355
3456## Markdown Formatting
3557
@@ -113,6 +135,14 @@ turn into an SPA as soon as you loaded a single page.
113135> without as much overhead. We'd lose some control over the nitty-gritty bits
114136> but we'd be passing over a lot of work over to ` gatsby ` .
115137
138+ __ UPDATE__
139+
140+ This is now working via dual configs exported as an array from
141+ ` webpack.prod.js ` . The site is now a both a statically generated site as well
142+ as an SPA (once you've entered any given page). The last key piece of the build
143+ process (besides figuring out markdown parsing) would be to incorporate an
144+ Service Worker making the site a full PWA (and knocking out that issue).
145+
116146
117147## Versioning & Releases
118148
0 commit comments