{"id":20981986,"url":"https://github.com/lowrisc/lowrisc-web","last_synced_at":"2025-05-14T16:31:11.570Z","repository":{"id":39308762,"uuid":"219297822","full_name":"lowRISC/lowrisc-web","owner":"lowRISC","description":"lowrisc.org web site sources","archived":false,"fork":false,"pushed_at":"2024-06-06T23:04:00.000Z","size":77015,"stargazers_count":3,"open_issues_count":18,"forks_count":6,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-06-07T00:22:54.371Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.lowrisc.org","language":"HTML","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/lowRISC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2019-11-03T12:31:25.000Z","updated_at":"2024-06-07T00:22:55.994Z","dependencies_parsed_at":"2023-02-06T11:46:05.571Z","dependency_job_id":"64bd4543-b709-48ae-bf52-88bae9e4dddb","html_url":"https://github.com/lowRISC/lowrisc-web","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Flowrisc-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Flowrisc-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Flowrisc-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowRISC%2Flowrisc-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lowRISC","download_url":"https://codeload.github.com/lowRISC/lowrisc-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225302865,"owners_count":17453016,"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":"2024-11-19T05:42:09.247Z","updated_at":"2024-11-19T05:42:09.996Z","avatar_url":"https://github.com/lowRISC.png","language":"HTML","readme":"# lowRISC web site\n\nThis repository contains the source code of the lowRISC web site. It is built\nusing Hugo, with all frontend assets being managed by Webpack.\n\n## Develop\n\n### Prerequisites\n\nYou need to install node.js and yarn on your machine. (Note: you do not need to\ninstall Hugo manually, it will be installed with yarn later.)\n\n- [nodejs](https://nodejs.org/en/download/)\n- [yarn](https://classic.yarnpkg.com/en/docs/install/)\n\n### Download all frontend dependencies\n\nBefore you can get started, you need to download all frontend dependencies\n(CSS and JS libraries), and Hugo. These dependencies will be installed into the\n`node_modules` directory.\n\n```bash\nyarn install\n```\n\n### Development\n\nThis repository is set up to give you an efficient development experience.\n\nAt the root of this repository, run\n\n```bash\nyarn start\n```\n\nA browser window will open and show you the web site. Now editing is easy: as\nsoon as you save changes to a source file the page in the browser will\nautomatically reload. No need to click the reload button!\n\nContent in Hugo can be marked as\n[draft or future content](https://gohugo.io/getting-started/usage/#draft-future-and-expired-content).\nTo see such content in the preview, run\n\n```bash\nyarn preview\n```\n\n## Deploy\n\nA static version of the web site can be built with:\n\n```bash\nyarn build-production\n```\n\nThis will produce the following expected warnings:\n```\nWARNING in unable to locate 'src/fonts/' at 'lowrisc-web/src/fonts'\n\nWARNING in entrypoint size limit: The following entrypoint(s) combined asset size exceeds the recommended limit (244 KiB). This can impact web performance.\nEntrypoints:\n  main (258 KiB)\n      main.e2036.css\n      main.e2036.js\n\n\nWARNING in webpack performance recommendations:\nYou can limit the size of your bundles by using import() or require.ensure to lazy load some parts of your application.\nFor more info visit https://webpack.js.org/guides/code-splitting/\n```\n\nPlease check the build output by opening `dist/index.html` in your web browser.\nIf the result does not look as expected, it is recommended to delete the whole `dist` folder and rebuild using `yarn build-production`.\n\nFinally, the whole build output, i.e., the content of `dist`, needs to be copied over to the actual website repo living in [https://github.com/lowRISC/lowrisc.github.io](https://github.com/lowRISC/lowrisc.github.io).\n\n## Frontend Processing Pipeline\n\nThis web site uses [Hugo](https://gohugo.io/) as a static site generator and\n[Webpack](https://webpack.js.org/) as JS/CSS asset pipeline.\n\n[PostCSS](http://postcss.org/) and [Babel](https://babeljs.io/) are used for CSS\nand JavaScript compiling/transpiling.\n\n### Add new node modules\n\nFrontend dependencies are generally handled through `yarn`.\n\n* Use `yarn add` to add dependencies.\n* Import JS and CSS modules in `index.js`.\n\n### CSS\n\nThis site uses Bootstrap 4, refer to https://getbootstrap.com for available\nclasses.\n\nStyles are edited as SASS files in `src/scss` and post-processed into (minified)\nCSS.\n\n### Images\n\nWe have a Hugo shortcode to downscale images, and create two variants: one for\nclients with a display scaling factor of 1, and another image for clients with a\n2x scaling factor (HighDPI or Retina displays). To use this functionality,\nfollow these steps:\n\n- Place images into the `content` directory, next to an `index.md` or\n  `index.html` file.\n- Reduce the size to about 2000px on the longer side to avoid overly large\n  images in the Git repository.\n- Use the `img` Hugo shortcode to include images:\n\n  ```\n  {{\u003c img class=\"any class you want\" src=\"image.png\" alt=\"alternative text (if image cannot be shown)\" title=\"some title (mouseover)\" \u003e}}\n  ```\n\n## License\n\n\"Technical parts\" of this web site are licensed under the Apache License,\nVersion 2.0. See file headers and LICENSE for details. Content is typically\nlicensed under CC BY-SA 4.0.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowrisc%2Flowrisc-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flowrisc%2Flowrisc-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowrisc%2Flowrisc-web/lists"}