[redesign] Better ways to share Less/EJS across sites

オープン
#308 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
node.js

調査の方向性

Start by reviewing the shared Less and EJS resources described across the documentation, blog, and pulsar-edit.github.io repositories, then inspect 11ty-config-pulsar and package.json for the proposed Node module approach. Done should mean the sites can share the relevant includes, mixins, headers, and footers with less duplication, but the issue needs a concrete design before implementation begins.

索引モデルが issue の本文から書いたものです。

説明

enhancement
Have you checked for existing feature requests?
  • Completed
Summary

I don't even know if there's a good solution here, but this is our current situation:

  • For all the redesigns, the documentation repo is the CSS source of truth; it emits a stylesheet that the others consume. The blog and pulsar-edit.github.io repos define their own CSS overrides, but often want to consult the original Less includes (i.e., the breakpoints and mixins) and can't; so they get duplicated across repos.
  • The sites may or may not want to highlight different things in their navigation areas, but otherwise should basically have the same page header and page footer. Right now, this is another thing that must be duplicated across three repos.

I don't have a preferred recommendation here because they'd all involve some pain. But here are some ideas:

  • Git submodule? (Ugh.)
    • Pros: would allow us to reference the individual files rather easily.
    • Cons: Now we've got four repos instead of three, and keeping everything in sync still requires manual submodule updates and redeploys of each site.
  • Extend 11ty-config-pulsar?
    • Not sure how easy it is to even reference Less or EJS resources from a Node module, but maybe it's possible via require.resolve or something. And maybe it can define some EJS helpers that can do most of the work instead of forcing us to reach in and include the module's own EJS files.
    • Pros: We're already using it in the other two repos.
    • Cons: Same deployment headaches as above, though they may be slightly mitigated if the package.json version just points to github:confused-Techie/11ty-config-pulsar#main and therefore always gets the latest upon redeploy.
What benefits does this feature provide?

Less duplication; more consistency.

Any alternatives?

The two possible solutions above are the only ones I can think of for now, but I'm eager to hear others if folks have ideas.

Other than that, the alternative is living with the status quo — which is annoying but not debilitating.

Other examples:

No response

主要言語
EJS
スター
31
フォーク
33
平均マージ
2分
マージ済み PR(30日)
2

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

pulsar-edit/pulsar-edit.github.io のほかの issue

pulsar-edit/pulsar-edit.github.io の issue をすべて見る

似ている issue

Build System の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。