{"id":25844126,"url":"https://github.com/regolith-linux/regolith-desktop.com","last_synced_at":"2025-11-25T10:02:13.048Z","repository":{"id":38253393,"uuid":"439733724","full_name":"regolith-linux/regolith-desktop.com","owner":"regolith-linux","description":"Website of regolith-desktop.com","archived":false,"fork":false,"pushed_at":"2025-01-30T20:41:50.000Z","size":95543,"stargazers_count":11,"open_issues_count":4,"forks_count":32,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T21:29:06.650Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://regolith-desktop.com/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regolith-linux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-18T23:15:36.000Z","updated_at":"2025-01-30T20:40:17.000Z","dependencies_parsed_at":"2023-01-29T20:30:21.163Z","dependency_job_id":"2bf63b30-08cc-4f81-8115-c333b8613143","html_url":"https://github.com/regolith-linux/regolith-desktop.com","commit_stats":{"total_commits":232,"total_committers":26,"mean_commits":8.923076923076923,"dds":0.6594827586206897,"last_synced_commit":"f8ce2d8a754b8776dfd7f95640159dcf7f046a42"},"previous_names":["regolith-linux/regolith-desktop.com"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regolith-linux%2Fregolith-desktop.com","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regolith-linux%2Fregolith-desktop.com/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regolith-linux%2Fregolith-desktop.com/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regolith-linux%2Fregolith-desktop.com/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regolith-linux","download_url":"https://codeload.github.com/regolith-linux/regolith-desktop.com/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240748341,"owners_count":19851242,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-01T07:22:10.995Z","updated_at":"2025-11-25T10:02:08.011Z","avatar_url":"https://github.com/regolith-linux.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# This is the https://regolith-desktop.com website\n\nThis site uses the [Hugo static site generator](https://gohugo.io/) and the [Hextra theme](https://themes.gohugo.io/themes/hextra/).\n\n## Local Development\n\nPlease ensure you have the following installed:\n\n- Hugo **extended** **\u003e= 0.140.0** (otherwise PostCSS won't work)\n- npm\n- git\n\n### Checkout and View Local\n\nClone this repo, and the Book theme as a submodule:\n\n```console\n$ git clone git@github.com:regolith-linux/regolith-desktop-website.git regolith-desktop-website\n$ cd regolith-desktop-website\n```\n\nInstall dependencies and launch Hugo server:\n\n```console\n$ hugo \n$ hugo server\n```\n\n...or, with Docker:\n\n```console\ndocker compose up\n```\n\n### Make changes\n\nEdit content as needed. If `hugo server` is running then updates are automatically reloaded after committing changes to disk.\n\n### Update website on GitHub Pages\n\nGitHub Actions on the repository is configured to deploy any and all changes to the `gh-pages` branch automatically, no further action needed. The `CNAME` ([https://regolith-desktop.com](https://regolith-desktop.com)) is configured automatically, no need to add it.\n\nIf you believe that your changes ought to be reviewed by a second party, just open a pull request and have somebody else jump in and cross-check your edits.\n\n### Shortcodes\n\nAdditional shortcodes are:\n\n- `keys`: To insert a recognizable sequence of keypresses, e.g. `{{\u003c keys \"super,shift,q\" \u003e}}`. The block also accepts an optional delimiter, should you need `,` as a keypress, e.g. `{{\u003c keys \"super|,\" \"|\" \u003e}}`\n- `img`: To insert an image, including automated, cross-device sizing, a lightbox and an alt text, e.g. `{{\u003c img \"images/my-image.jpg\" \"Some alt text\" \u003e}}`\n- `supported_version`: To insert the Ubuntu versions, delimited by commas, which are currently supported by Regolith Linux, e.g. `{{\u003c supported_versions \u003e}}` (they are taken from the `config.toml` `params` section). You can either choose to display the version _numbers_ or the version _names_, with _numbers_ being the default. To display the names use `{{\u003c supported_version type=\"names\" \u003e}}`\n\n### Conventions\n\n#### Use Markdown wherever possible\n\nAlthough Hugo accepts common HTML elements pretty much anywhere the expressed goal is to rely on Markdown and its syntax for pretty much anything _within the confines of the `content` directory itself_. If you need to style something differently, try using [a shortcode](https://gohugo.io/templates/shortcode-templates/) first, before actually styling the page in \"pure\" HTML. Some pages are violating this concern, mostly because the underlying theme does as well, but for the sake of making it easier on folks to edit and especially translate the content as well as keeping a consistent style across languages they should be free of HTML.\n\n#### Use `prettier` for formatting files (especially Markdown)\n\n[`prettier`](https://www.npmjs.com/package/prettier) is a versatile formatter for JavaScript/TypeScript and everything related to HTML as well as JSON/YAML and TOML. Please use it to format all the content in the repository that `prettier` is capable of processing. Manual formatting will show up as an error in the future and PRs changing formatting that's different from `prettier` output will not be accepted.\n\n#### Use `console` for highlighting shell session code\n\nIf you want to show a command that users can run, you are encouraged to use `bash` for code highlighting. But if the command you are showing has an output you need to use `console`.\n\nThis block uses `bash` for highlighting:\n\n```bash\nsudo apt update\nsudo apt install regolith-desktop\n```\n\nBut this uses `console` (note that this command is also showing and output):\n\n```console\n$ xrandr --listmonitors\nMonitors: 1\n 0: +*eDP-1 1920/309x1080/173+0+0  eDP-1\n```\n\nUsing `bash` obscures the flow of information and things you type into a session isn't really shell code all the time but rather a random set of commands. There's [an open feature request](https://github.com/alecthomas/chroma/issues/137) with the highlighting engine (\"Chroma\") Hugo is using to accept `console` as a lexer. Once that's accomplished all the relevant highlighting parts will look different. For now, they'll just receive the default styling.\n\n\n#### Call it `Xresources` (with backticks)\n\nNo `Xresource` or Xresource. Use the plural (because that's what we read and what the definition of the mechanism is) and surround the word itself with backticks to make it stand out a little.\n\n#### Put images into `static/images` and use the `img` shortcode\n\nWe don't want duplicate content anywhere, especially not images that are the same for every single translation. Therefor we put images into the `static/images` folder and use the `img` shortcode to refer to them. You'll get a lightbox and automated, screen-aware (i.e. \"mobile friendly\") sizing on top. The `img` shortcode has the following syntax:\n\n```go-html-template\n{{\u003c img \"\u003cpath-to-image-in-asset-folder\u003e\" \"alt-text-for-image\" \u003e}}\n```\n\nExample:\n\n```go-html-template\n{{\u003c img \"images/my-image.jpg\" \"Some image\" \u003e}}\n```\n\n#### Use `ref` or `relref` for linking between content\n\nContent changes, page names change. Using a hardcoded path in Markdown links will break sooner or later. Hugo [has two built-in functions](https://gohugo.io/content-management/cross-references/), `ref` (preferred) or `relref`, to make sure links are viable and linking to the right content. Use them whenever you're linking to \"internal\" content.\n\n**Note**: Hugo will fail to render the page if a link is \"dead\" and you will have to fix it before you can continue. We consider this a feature!\n\n#### Use the Markdown footnote syntax to render footnotes\n\nHugo allows for specifying footnotes in [the regular Markdown syntax](https://michelf.ca/projects/php-markdown/extra/#footnotes), e.g. `[^1]` for the note in the text and `[^1]: Some text` (mind the colon) wherever you want to place the footnote text. It has the added advantage that the footnote also links back to the text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregolith-linux%2Fregolith-desktop.com","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregolith-linux%2Fregolith-desktop.com","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregolith-linux%2Fregolith-desktop.com/lists"}