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.
fdd7550ee1
fuck-premake-old2/website
History
KyrietS f333f82bc0 Add Github Action workflow for website deployment
2021-03-25 20:52:06 +01:00
..
docs Port user guide pages from wiki 2021-03-17 10:50:56 -04:00
src Rework website home & download pages 2021-03-24 10:42:08 -04:00
static Introduce new website with docs with docusaurus 2021-02-15 21:19:29 +01:00
.gitignore Introduce new website with docs with docusaurus 2021-02-15 21:19:29 +01:00
babel.config.js Introduce new website with docs with docusaurus 2021-02-15 21:19:29 +01:00
docusaurus.config.js Add Github Action workflow for website deployment 2021-03-25 20:52:06 +01:00
package.json Introduce new website with docs with docusaurus 2021-02-15 21:19:29 +01:00
README.md Add Github Action workflow for website deployment 2021-03-25 20:52:06 +01:00
sidebars.js Port user guide pages from wiki 2021-03-17 10:50:56 -04:00

README.md

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.

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.