Comments (3)
This is a tricky problem.
I'm not super excited about the overhead of adding a GitHub action for Option 3. It will certainly generate Git merge conflicts when multiple branches update the spec. This problem is similar to the starter files tarball problem and most people (including instructors) are helpless when it comes to resolving merge conflicts.
I kinda like Option 1 despite its limitations.
from primer-spec.
Update: I am one step closer to making this a reality!
Now that GitHub Pages can be deployed via GitHub Actions, we can run arbitrary commands to generate static files. I created a custom action to build Primer Spec (see #212).
For the past month, I've been playing around trying to get dynamic PDF generation to work. Thanks to amazing support from GitHub's Support team, I have a working prototype!
- GitHub Action: https://github.com/seshrs/build-primer-spec-action/blob/48edf3da1472a337b3c827a3de198646901bafdd/action.yml#L24-L51
- Example page: https://seshrs.github.io/ci-playground/nested-dir/nested-spec-test.html
- Corresponding PDF: https://seshrs.github.io/ci-playground/assets/primer-spec-pdf/nested-dir/nested-spec-test.pdf
Now, all that's left is to figure out how to create a UI in Primer Spec to link students to the PDF. I'll need some time to explore UIs (and maybe correspond with @bellakiminsun) β meanwhile, I'd welcome suggestions and design proposals from anyone
from primer-spec.
from primer-spec.
Related Issues (20)
- `script/server` requires specific shells HOT 7
- Bump header level styles in sidebar if needed HOT 1
- Primer Spec v2: Require deploy via GitHub Actions? HOT 1
- Task Lists: Use 'pointer' cursor on hover
- Multi color highlighting HOT 5
- Spooky icons even when Spooky theme not chosen HOT 2
- Data-highlight inside callout HOT 2
- Sidebar links broken in preview HOT 5
- Dark mode code blocks flash when settings is closed HOT 1
- Markdown tables are not rendered HOT 2
- Copy button in enhanced codeblock omits whitespace HOT 3
- Enhanced code block copy-paste trailing newline
- [PR Previews] PDFs do not generate with correct styles the first time.
- [Code blocks] Overflow gets clipped in print previews
- [Enhanced code blocks] No-line-numbers variant doesn't occupy full width
- [Enhanced code blocks] Code block in EECS 280 P1 doesn't highlight lines HOT 1
- [Enhanced Code Blocks] Line-by-line copying excludes empty lines
- Local render Liquid Exception HOT 6
- Copying an enhanced codeblock duplicates newlines HOT 1
- Sidebar has wrong URLs in PR previews HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from primer-spec.