AuroraPipeline/fuck-premake-old2
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity
This repository has been archived on 2022-12-23. You can view files and clone it, but cannot push or open issues or pull requests.
d32e893d47
fuck-premake-old2/website/README.md
starkos d32e893d47 Break out community section on website
2021-03-29 16:18:54 -04:00

1.7 KiB
Raw Blame History

Premake Website

Premake website is built using Docusaurus 2, a modern static website generator.

Installation

npm install

Local Development

npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

To see a list of broken links (mistakes happen!), be sure to run npm run build before submitting updates. Your changes will be rejected if they contain broken links.

Build

npm run-script build

This command generates static content into the build directory and can be served using any static contents hosting service.

GitHub Actions

  • Every push and pull request that affects anything in website/** will trigger website build (to make sure that no errors like broken links were introduced)
  • Every push to the master branch in this repo that affects anything in website/** will trigger website deployment. It means that the website will be built and pushed to the master branch of premake.github.io.

Deployment

Target repo for deployment is specified in docusaurus.config.js.

  • organizationName is a GitHub account name: github.com/premake/premake.github.io
  • projectName is a target repository: github.com/premake/premake.github.io

docusaurus deploy command is used to automatically build and push static files into premake.github.io repo.

Deployments are authenticated by a key pair. The private key is hosted in premake-core in Settings > Secrets. The public key is host in premake.github.io in Settings > Deploy Keys.