From 573abd0ee3a9aa495f3556882e48f1dbef78def3 Mon Sep 17 00:00:00 2001 From: Koen Lageveen Date: Sat, 5 Jul 2025 14:40:46 +0200 Subject: [PATCH 01/11] add channel assets to the public dir --- Makefile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Makefile b/Makefile index a0fc8c115..8420166e7 100644 --- a/Makefile +++ b/Makefile @@ -2,6 +2,8 @@ build: npm install curl -o workspace.json -L "https://github.com/packagecontrol/thecrawl/releases/download/crawler-status/workspace.json" npx @11ty/eleventy + curl -o _site/channel.json -L "https://github.com/packagecontrol/thecrawl/releases/download/the-channel/channel.json" + curl -o _site/channel_st3.json -L "https://github.com/packagecontrol/thecrawl/releases/download/the-st3-channel/channel_st3.json" lint: npx eslint From b9e7cbaf536a230a473239c6bcddc0f80eb73614 Mon Sep 17 00:00:00 2001 From: Koen Lageveen Date: Sat, 5 Jul 2025 14:41:58 +0200 Subject: [PATCH 02/11] start writing the faq page and tweak layouts to better support prose, limit widths --- _includes/header.njk | 41 ++++++++++++++++++----------------- _includes/layout.njk | 2 +- about.md | 45 ++++++++++++++++++++++++++++++++++++++ static/style/header.css | 17 ++++++--------- static/styles.css | 48 +++++++++++++++++++++++++++++------------ 5 files changed, 108 insertions(+), 45 deletions(-) create mode 100644 about.md diff --git a/_includes/header.njk b/_includes/header.njk index aa0828930..da2840c78 100644 --- a/_includes/header.njk +++ b/_includes/header.njk @@ -1,23 +1,24 @@
- +
+ -

Package Control R

-

The Sublime Text package directory, {{ [ - "re-imagined", - "reassembled", - "rebooted", - "recompiled", - "refactored", - "reinvigorated", - "remastered", - "replenished", - "restarted", - "resurrected", - "revisited", - "rewired" - ] | random - }}.

+

Package Control R

+

The Sublime Text package directory, {{ [ + "re-imagined", + "reassembled", + "rebooted", + "recompiled", + "refactored", + "reinvigorated", + "remastered", + "replenished", + "restarted", + "resurrected", + "revisited", + "rewired" + ] | random + }}.

+
diff --git a/_includes/layout.njk b/_includes/layout.njk index f288f2fd9..a17f29bd2 100644 --- a/_includes/layout.njk +++ b/_includes/layout.njk @@ -5,7 +5,7 @@ {% include "header.njk" %} -
+
{{ content | safe }}
diff --git a/about.md b/about.md new file mode 100644 index 000000000..4913805d6 --- /dev/null +++ b/about.md @@ -0,0 +1,45 @@ +--- +layout: layout.njk +title: About / FAQ +--- + +# About + +**Package Control R** is the community-driven package management solution for Sublime Text. It's a front-to-back, top-to-bottom, **r**ewrite of the original [packagecontrol.io](https://packagecontrol.io), managed entirely by the Sublime Text community. + +The system consists of several components: + +- [This website](https://packages.sublimetext.io), listing publicly available packages for Sublime Text. +- A [website listing libraries](http://packagecontrol.github.io) (a.k.a. dependencies) available for package authors. +- A [registry of packages](https://github.com/wbond/package_control_channel), where you can submit your package to be published here as well. +- A [crawler](https://github.com/packagecontrol/thecrawl) that finds new versions of all packages and makes them available to the site, and the Package Control package. +- The [Package Control package](https://packages.sublimetext.io/packages/Package%20Control/) that provides the user interface inside Sublime Text to find, install and update packages. + +You can start using the hot newness today, by replacing all channels in your Package Control settings with the new one: + +```sh +https://packages.sublimetext.io/channel.json +``` + +If you're still using Sublime Text 3 (please upgrade, 4 is _so much_ better), you can use `https://packages.sublimetext.io/channel_st3.json`. + +## Why does the project exist? + +The original Package Control is aging. It was built in a different time, when many of the tools we take for granted today were not available. It has seen some iterations during its time, but it has reached the end of the road in several ways. Most importantly, it's currently not possible for the community to ensure it's ongoing stability and performance. + +Outages of certain aspects of the system, over the past year or so, have spurred members of the community (👏🙏 [@kaste](https://github.com/kaste)) to rebuild it from the ground up. + +Most of the assets related to Package Control have originated from Will Bond's original work. These might eventually become available to the community. Even so, much of it simply needs a new approach that better fits the project's new "governance model". + +## State of affairs + +This project is a work in progress. Some features, like the number of times a package has been installed, are currently missing. How some of these aspects are resolved is TBD, pending more information about the future of [packagecontrol.io](https://packagecontrol.io) and related assets. + +While the project is in flux, to not disturb users with potential breaking or disorienting changes, much of the user facing aspects remain unchanged. The package registry is still in it's "old" repository and might need to be moved eventually. And the "old" website is still up, and much more visible than this new one. The "old" `channel.json` is still the default that's included in the Package Control package. + +However, the website is functionally very far along. And more importantly, the crawler and the `channel.json` it generates are fully functional and reliable. + +## Other F.A.Q. + +- Q. Will the libraries websites be merged into this one? + - A. [Plausible](https://github.com/packagecontrol/thecrawl/pull/9) diff --git a/static/style/header.css b/static/style/header.css index 4f9e9c6d2..105ac14f0 100644 --- a/static/style/header.css +++ b/static/style/header.css @@ -3,6 +3,12 @@ header { padding: 4px 1rem; color: var(--foreground-lighter); + .inner { + max-width: 92rem; + margin: 0 auto; + position: relative; + } + * { margin: 0; padding: 0; @@ -16,22 +22,13 @@ header { color: var(--foreground); } - .hot { - color: var(--primary-accent); - font-style: italic; - } - nav { float: right; line-height: 1.33; padding-top: 1.33rem; + * + * { margin-left: 1ex; } - - @media (max-width: 600px) { - /* the links don't fit, but also appear in the footer so goodbye */ - display: none; - } } } diff --git a/static/styles.css b/static/styles.css index 004ecbf1c..e31640728 100644 --- a/static/styles.css +++ b/static/styles.css @@ -22,6 +22,11 @@ main { max-width: 80rem; margin: 0 auto; padding: 0 1rem 3.2rem 1rem; + + &.about-faq p { + /* limit paragraph length for readability */ + max-width: 52rem; + } } a { @@ -49,6 +54,29 @@ section { } } +code { + background: var(--background-darker); + border: 1px solid var(--background-darkest); + padding: 0 4px; + border-radius: 3px; + font-size: .9em; +} + +pre { + white-space: break-spaces; + background: var(--background-darker); + &:not(.fallback) { + border: 1px solid var(--background-darkest); + padding: 1rem; + } + code { + background: revert; + border: revert; + padding: revert; + border-radius: revert; + } +} + .screenreader-only { width: 1px; height: 1px; @@ -58,6 +86,11 @@ section { overflow:hidden } +.hot { + color: var(--primary-accent); + font-style: italic; +} + .description { font-size: 25px; line-height: 44px; @@ -127,24 +160,11 @@ dl { code { background: var(--background); - border: 1px solid var(--background-darker); - padding: 0 4px; - border-radius: 3px; + border-color: var(--background-darker); } pre { - white-space: break-spaces; background: var(--background); - &:not(.fallback) { - border: 1px solid var(--background-darker); - padding: 1rem; - } - code { - background: revert; - border: revert; - padding: revert; - border-radius: revert; - } } } From a503b87110509702e844b78ca2729f12efcd5f50 Mon Sep 17 00:00:00 2001 From: Koen Lageveen Date: Sat, 5 Jul 2025 21:06:28 +0200 Subject: [PATCH 03/11] improve content width --- _includes/layout.njk | 4 ++-- static/styles.css | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_includes/layout.njk b/_includes/layout.njk index a17f29bd2..a3a97a695 100644 --- a/_includes/layout.njk +++ b/_includes/layout.njk @@ -1,11 +1,11 @@ - + {% include "head.njk" %} {% include "header.njk" %} -
+
{{ content | safe }}
diff --git a/static/styles.css b/static/styles.css index e31640728..289ff20f9 100644 --- a/static/styles.css +++ b/static/styles.css @@ -19,13 +19,13 @@ body { } main { - max-width: 80rem; + max-width: 78rem; margin: 0 auto; padding: 0 1rem 3.2rem 1rem; - &.about-faq p { + html.about-faq & { /* limit paragraph length for readability */ - max-width: 52rem; + max-width: 48rem; } } From ef409daf7ac2b73dc6ae38065ab41c3903858c5f Mon Sep 17 00:00:00 2001 From: Koen Lageveen Date: Sat, 5 Jul 2025 21:06:41 +0200 Subject: [PATCH 04/11] tweak code font-size --- static/style/typography.css | 2 +- static/styles.css | 22 +++++++++++++++++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/static/style/typography.css b/static/style/typography.css index 6896bf75c..a68d523e6 100644 --- a/static/style/typography.css +++ b/static/style/typography.css @@ -15,9 +15,9 @@ background-position-y: 26px !important; }*/ -pre, code { font-family: "IBM Plex Mono", monospace; + font-size: 0.92em; } html, diff --git a/static/styles.css b/static/styles.css index 289ff20f9..095abba8f 100644 --- a/static/styles.css +++ b/static/styles.css @@ -59,7 +59,6 @@ code { border: 1px solid var(--background-darkest); padding: 0 4px; border-radius: 3px; - font-size: .9em; } pre { @@ -77,6 +76,27 @@ pre { } } +.clipboard-wrapper { + position: relative; + &.copied pre { + background: var(--background-darkest); + } + pre { + transition: background .1s ease-out; + padding-right: 6em; + word-break: break-word; + } + button { + position: absolute; + top: 1rem; + right: 1rem; + margin: 0; + padding: 0; + background: transparent; + color: var(--primary-accent-darker); + } +} + .screenreader-only { width: 1px; height: 1px; From 26ab5908a05931cc0ea89f712ad7efcc4563960c Mon Sep 17 00:00:00 2001 From: Koen Lageveen Date: Sat, 5 Jul 2025 21:06:50 +0200 Subject: [PATCH 05/11] about edits --- about.md | 53 +++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 41 insertions(+), 12 deletions(-) diff --git a/about.md b/about.md index 4913805d6..fecc4ab7a 100644 --- a/about.md +++ b/about.md @@ -11,35 +11,64 @@ The system consists of several components: - [This website](https://packages.sublimetext.io), listing publicly available packages for Sublime Text. - A [website listing libraries](http://packagecontrol.github.io) (a.k.a. dependencies) available for package authors. -- A [registry of packages](https://github.com/wbond/package_control_channel), where you can submit your package to be published here as well. -- A [crawler](https://github.com/packagecontrol/thecrawl) that finds new versions of all packages and makes them available to the site, and the Package Control package. +- A [registry of packages](https://github.com/wbond/package_control_channel), where you can submit your package to be published here. +- A [crawler](https://github.com/packagecontrol/thecrawl) that finds new versions of all packages and makes them available to the site, and to the Package Control package. - The [Package Control package](https://packages.sublimetext.io/packages/Package%20Control/) that provides the user interface inside Sublime Text to find, install and update packages. -You can start using the hot newness today, by replacing all channels in your Package Control settings with the new one: +You can start using the hot newness today, by replacing the existing channel in your Package Control package settings with the new one: ```sh https://packages.sublimetext.io/channel.json ``` -If you're still using Sublime Text 3 (please upgrade, 4 is _so much_ better), you can use `https://packages.sublimetext.io/channel_st3.json`. +If you're still using Sublime Text 3, you can use: +`https://packages.sublimetext.io/channel_st3.json` -## Why does the project exist? +## Why does this website exist? -The original Package Control is aging. It was built in a different time, when many of the tools we take for granted today were not available. It has seen some iterations during its time, but it has reached the end of the road in several ways. Most importantly, it's currently not possible for the community to ensure it's ongoing stability and performance. +The original [Package Control](https://packagecontrol.io) is aging. It was built in a different time, when many of the tools we take for granted today were not available. It has seen some iterations during its time, but it has reached the end of the road in several ways. Most importantly, it's currently not possible for the community to ensure its ongoing stability and performance. -Outages of certain aspects of the system, over the past year or so, have spurred members of the community (👏🙏 [@kaste](https://github.com/kaste)) to rebuild it from the ground up. +Outages of certain aspects of the system, over the past year or so, have spurred members of the community (🙇‍♂️ [@kaste](https://github.com/kaste) and the entire crew) to rebuild it from the ground up. -Most of the assets related to Package Control have originated from Will Bond's original work. These might eventually become available to the community. Even so, much of it simply needs a new approach that better fits the project's new "governance model". +Building this while keeping the original in place, allows us to iterate towards feature-completeness and stability. This also enables us to find new solutions that better fit the project's new "governance model". Eventually, hopefully we will be able to fully replace Will Bond's original project (and domain name), but these things take time to organize properly. ## State of affairs -This project is a work in progress. Some features, like the number of times a package has been installed, are currently missing. How some of these aspects are resolved is TBD, pending more information about the future of [packagecontrol.io](https://packagecontrol.io) and related assets. +This project is a work in progress. Some features, like counting how often a package has been installed, are currently missing. While the project is in flux, to not disturb users with potential breaking or disorienting changes, much of the user facing aspects of Package Control remain unchanged. +The package registry is still in it's "old" GitHub repository, and might be moved eventually. And the "old" website is still up, and much more visible than this new one. The "old" `channel.json` is still the default that's included in the Package Control package. -While the project is in flux, to not disturb users with potential breaking or disorienting changes, much of the user facing aspects remain unchanged. The package registry is still in it's "old" repository and might need to be moved eventually. And the "old" website is still up, and much more visible than this new one. The "old" `channel.json` is still the default that's included in the Package Control package. +However, the website is functionally very far along, features all packages and is updated throughout the day with new release versions. And more importantly, the crawler and the `channel.json` it generates, are fully functional and very reliable. -However, the website is functionally very far along. And more importantly, the crawler and the `channel.json` it generates are fully functional and reliable. +You are very much invited to make the switch and come along for the ride! ## Other F.A.Q. -- Q. Will the libraries websites be merged into this one? +- Q. Where can I ask questions? + - A. On [discord](https://discord.sublimetext.io/): look for the "#package-control" channel. +- Q. Where can I contribute or report issues? + - A. On [GitHub](https://github.com/packagecontrol/thecrawl/issues). +- Q. Will the libraries website be merged into this one? - A. [Plausible](https://github.com/packagecontrol/thecrawl/pull/9) + + + From e2a19d6418fdd291ea985b64945f0855cfebd054 Mon Sep 17 00:00:00 2001 From: Koen Lageveen Date: Sat, 5 Jul 2025 21:27:14 +0200 Subject: [PATCH 06/11] more edits! --- about.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/about.md b/about.md index fecc4ab7a..6e500d8d5 100644 --- a/about.md +++ b/about.md @@ -5,17 +5,17 @@ title: About / FAQ # About -**Package Control R** is the community-driven package management solution for Sublime Text. It's a front-to-back, top-to-bottom, **r**ewrite of the original [packagecontrol.io](https://packagecontrol.io), managed entirely by the Sublime Text community. +**Package Control R** is the community-driven package management solution for Sublime Text. It's a front-to-back, top-to-bottom, rewrite of the original [packagecontrol.io](https://packagecontrol.io), managed entirely by the Sublime Text community. The system consists of several components: - [This website](https://packages.sublimetext.io), listing publicly available packages for Sublime Text. - A [website listing libraries](http://packagecontrol.github.io) (a.k.a. dependencies) available for package authors. - A [registry of packages](https://github.com/wbond/package_control_channel), where you can submit your package to be published here. -- A [crawler](https://github.com/packagecontrol/thecrawl) that finds new versions of all packages and makes them available to the site, and to the Package Control package. -- The [Package Control package](https://packages.sublimetext.io/packages/Package%20Control/) that provides the user interface inside Sublime Text to find, install and update packages. +- A [crawler](https://github.com/packagecontrol/thecrawl) that compiles the data that drives the system: it finds new versions of all packages and makes them available to the site, and to the Package Control package. +- The [Package Control package](https://packages.sublimetext.io/packages/Package%20Control/) that provides the user interface inside Sublime Text, to find, install, and update packages. -You can start using the hot newness today, by replacing the existing channel in your Package Control package settings with the new one: +You can start using the new hotness today, by replacing the existing channel in your Package Control package settings with the new one: ```sh https://packages.sublimetext.io/channel.json @@ -28,9 +28,9 @@ If you're still using Sublime Text 3, you can use: The original [Package Control](https://packagecontrol.io) is aging. It was built in a different time, when many of the tools we take for granted today were not available. It has seen some iterations during its time, but it has reached the end of the road in several ways. Most importantly, it's currently not possible for the community to ensure its ongoing stability and performance. -Outages of certain aspects of the system, over the past year or so, have spurred members of the community (🙇‍♂️ [@kaste](https://github.com/kaste) and the entire crew) to rebuild it from the ground up. +Outages of certain aspects of the system over the past year or so, have spurred members of the community (🙇‍♂️ [@kaste](https://github.com/kaste) and crew) to rebuild it from the ground up. -Building this while keeping the original in place, allows us to iterate towards feature-completeness and stability. This also enables us to find new solutions that better fit the project's new "governance model". Eventually, hopefully we will be able to fully replace Will Bond's original project (and domain name), but these things take time to organize properly. +Building this while keeping the original in place, allows us to iterate towards feature-completeness and stability. This also enables us to find new solutions that better fit the project's new "governance model". Hopefully we will eventually be able to fully replace Will Bond's original project (and domain name), but these things take time to organize properly. ## State of affairs @@ -43,13 +43,14 @@ You are very much invited to make the switch and come along for the ride! ## Other F.A.Q. -- Q. Where can I ask questions? - - A. On [discord](https://discord.sublimetext.io/): look for the "#package-control" channel. -- Q. Where can I contribute or report issues? - - A. On [GitHub](https://github.com/packagecontrol/thecrawl/issues). -- Q. Will the libraries website be merged into this one? - - A. [Plausible](https://github.com/packagecontrol/thecrawl/pull/9) - +- Q: Where can I ask questions? + - A: On [discord](https://discord.sublimetext.io/): look for the "#package-control" channel. +- Q: Where can I contribute or report issues? + - A: On [GitHub](https://github.com/packagecontrol/thecrawl/issues). +- Q: Will the libraries website be merged into this one? + - A: [Plausible](https://github.com/packagecontrol/thecrawl/pull/9) +- Q: What does the "R" stand for? + - A: Rewrite, refactor, revisited... something along those lines 😉