README.md
1# Premake Website
2
3Premake website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. Search functionality is provided for free by [Algolia DocSearch](https://docsearch.algolia.com/).
4
5All docs pages can be found in the `docs/` folder.
6
7## Adding a new entry to the docs
8Editing our documentation website is very simple. You don't have to build a whole website for this. All pages are stored in Markdown files, so in order to add a new entry:
9
101. Add a new Markdown file into the `docs/` folder. Follow naming conventions there.
112. Add your Markdown file's name into the `sidebars.js`. Make sure you've kept alphabetical order among category items.
12
13*Use other files as references.*
14
15## Installation
16
17```
18npm install
19```
20
21## Local Development
22
23```
24npm start
25```
26
27This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
28
29To 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.
30
31## Build
32
33```
34npm run-script build
35```
36
37This command generates static content into the `build` directory and can be served using any static contents hosting service.
38
39## GitHub Actions
40
41* 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)
42* 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](https://github.com/premake/premake.github.io).
43
44## Deployment
45
46Target repo for deployment is specified in `docusaurus.config.js`.
47
48* `organizationName` is a GitHub account name: github.com/**premake**/premake.github.io
49* `projectName` is a target repository: github.com/premake/**premake.github.io**
50
51`docusaurus deploy` command is used to automatically build and push static files into [premake.github.io](https://github.com/premake/premake.github.io) repo.
52
53Deployments 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**.
54