Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade docs to latest Docusaurus version. #2269

Merged
merged 1 commit into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '14'
node-version: '18'
- name: Test Build
run: |
cd website
Expand All @@ -28,7 +28,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: '14'
node-version: '18'
- name: Add key to allow access to repository
env:
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2019-08-31-community-update-1.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #1"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

Say hello to [the new Premake OpenCollective](https://opencollective.com/premake)!
Expand All @@ -23,6 +20,8 @@ The experiment is now officially underway. As long as it continues, I'll provide

- Improve the collaboration process with new issue, feature, and pull request templates ([#1326](https://github.com/premake/premake-core/pull/1326), [#1327](https://github.com/premake/premake-core/pull/1327))

{/* truncate */}

I'm not charging any expenses against the collective this cycle so we can build up a balance to recognize cool or important contributions from the community. You can track our finances and transactions at any time on [our OpenCollective page](https://opencollective.com/premake).

For the next cycle, I'd like to show a little maintainer love by working down (and ideally clearing) the [open pull request queue](https://github.com/premake/premake-core/pulls) and, time permitting, do a bit of grooming on the [open issue list](https://github.com/premake/premake-core/issues) as well. Longer term, I've put a great deal of time and thought into fixing Premake's core configuration engine, which is holding back development on a number of important features. I've figured out [how it should work](https://github.com/industriousone/premake-query); now I'm puzzling over [how to get there](https://github.com/starkos/premake-next) from where we are.
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2019-10-23- community-update-2.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #2"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

For this cycle (I work in eight-week cycles and fill in as much Premake work as I can), I completed a long overdue pruning of [the pull request backlog](https://github.com/starkos/premake-next/pulls). Working up from the oldest, I was able to get it down to just four, all in striking distance of merging and just needing a little follow-up (assistance welcome!). I'll drop a list of all the PRs that were moved at the bottom of this update. Because…
Expand All @@ -19,6 +16,8 @@ For the next cycle, I plan to start filling in the details of an improved config

~st.

{/* truncate */}

**Completed Tasks:**

- Boostrapped [Premake-next](https://github.com/starkos/premake-next)
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2020-01-08-community-update-3.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #3"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

Just a quick update this time: I had big plans for new features this cycle, but ended up getting swamped in end-of-year deadlines, and was only able to deliver a small portion of what I had intended (and late, at that). Still, I did manage a quick port-and-polish of the unit testing module and all of its dependencies, so I'm well positioned to begin the new user scripting API work in earnest. I will be on the road a fair bit over the next quarter, but I'm still optimistic that I can get enough of the new system online to give folks a sense of where things are headed.
Expand All @@ -16,3 +13,5 @@ Many thanks to **[CitizenFX Collective](https://opencollective.com/_fivem)** and
~st.

(Your feedback is welcome and appreciated—come find us at [github.com/premake](https://github.com/premake) or [@premakeapp](https://twitter.com/premakeapp).)

{/* truncate */}
7 changes: 3 additions & 4 deletions website/blog/2020-04-07-community-update-4.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #4"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

It's been much longer than anticipated since the last community update. I was out of the country for a bit, and then shortly after my return the whole Situation hit the fan and things got crazy for a while. I'm back now, up and running and looking ahead to what's next. I hope all of you are also safe and sound and getting your groove back.
Expand All @@ -21,6 +18,8 @@ Whew!

With inbox zero reached, we also cut [a new 5.0 alpha release](https://github.com/premake/premake-core/releases/tag/v5.0.0-alpha15) with over 50 changes and fixes, from over 20 different contributors. Nicely done everyone, and thanks! 🙌

{/* truncate */}

#### Premake5 Stable?

Speaking of changes and releases, [#1423](https://github.com/premake/premake-core/issues/1423) from [@dvzrz](https://github.com/dvzrv) asks whether it's (finally) time to cut a stable release of Premake5. Fair question! As I responded on the issue, [@saminsane](https://github.com/samsinsane) and I have discussed this before, and our general feeling is that there are too many big, breaking changes that still need to be made.
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2020-08-04-community-update-5.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #5"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

### The new storage system has arrived
Expand All @@ -17,6 +14,8 @@ Learning my lesson from past development, I did my best to make this new version

**A proper API.** The storage and query API have been cleaned up and condensed to make things easier and more powerful for module authors. (Sorry for the inline images, the OpenCollective editor won't allow me to author code blocks?)

{/* truncate */}

```lua
-- create a new query, targeting a particular "environment";
-- returns the global configuration for that environment
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2020-11-02-community-udpate-6.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #6"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

### Enter the Exporters
Expand All @@ -27,6 +24,8 @@ For those of you who are more interested in "is it done yet?" than "what's new?"

Somewhere in there I should also backfill the documentation so people know what's working. All of this is subject to change and peer pressure, feedback welcome.

{/* truncate */}

### What's New

I'm doing my best to keep [an inventory of the major changes here](https://github.com/starkos/premake-next/blob/master/docs/Changes-Since-v5.md); let me know if you spot anything missing (and thanks to those who have already).
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2021-02-24-community-update-7.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #7"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

A quick update this cycle so I can get right back to it: I managed to free up meaningful blocks of time for Premake in February—felt good!—and tackle **files** and **removeFiles**, support configuration and platform specific files, and get it all exporting to Visual Studio (…and bulldoze through the rabbit holes along the way). From the user-facing side not a big change, but [a hefty commit](https://github.com/starkos/premake-next/commit/f5cb8678a6cc2939faceacbb8143bd9a094709f6) just the same. The core platform is starting to feel reasonably complete.
Expand All @@ -16,6 +13,8 @@ A quick update this cycle so I can get right back to it: I managed to free up me

Longer term: push to get the new code to the point where it can generate its own Visual Studio project files. I've actually done a good chunk of work on this, but wasn't quite able to bring it home this month. Then do the same with Xcode.

{/* truncate */}

### Meanwhile in V5

The community making the world a better place…
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2021-04-20-community-update-8.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #8"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

### Welcome Website!
Expand All @@ -25,6 +22,8 @@ I…did not realize how long it had been since there was a proper release. Pande

(By the way, if anyone out there has a knack for build automation I'd love to see these releases automated. Get in touch!)

{/* truncate */}

### RFC: Branch or Backport

I also finally sat down and [opened an RFC](https://github.com/premake/premake-core/discussions/1616) to figure out what to do with the work going on over at [premake-next](https://github.com/starkos/premake-next): branch and push ahead to a v6, or backport the improvements into v5? I've gone back and forth on it but came down on the side of branching; now I'd love to hear what the community thinks. Join the discussion [here](https://github.com/premake/premake-core/discussions/1616).
Expand Down
7 changes: 3 additions & 4 deletions website/blog/2021-08-01-community-update-9.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #9"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

I can't believe we're already eight months into 2021, how did this happen.
Expand All @@ -27,6 +24,8 @@ In other news, Premake6 can now generate its own Visual Studio project files and

[@nickclark2016](https://github.com/nickclark2016) has volunteered to begin looking into a new-and-improved makefile exporter, which frees me up to start looking at Xcode and improving the way we represent toolsets like Clang and GCC. The stable release of 5.0 is likely to take up all the air in the room for a bit, but hopefully I can report progress on those soon.

{/* truncate */}

### Community Contributions

The community keeps things rolling—many thanks to everyone listed here!
Expand Down
9 changes: 4 additions & 5 deletions website/blog/2021-11-21-community-update-10.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Community Update #10"
tags: [community-updates]
author: starkos
author_url: https://github.com/starkos
author_image_url: https://avatars.githubusercontent.com/u/249247?v=4
author_title: Premake Admin & Developer
authors: starkos
---

### Premake 5.0-beta1! 🥳
Expand All @@ -15,6 +12,8 @@ As [previously discussed](/blog/2021/08/01/community-update-9#the-path-to-50), w

Most of the changes in the queue are under-the-hood: release automation, bootstrapping, and unit test fixes. The only potentially significant breaking change remaining is [promoting the `gmake2` exporter](https://github.com/premake/premake-core/issues/1099), which I will be prioritizing for the next beta. If you happen to still be using the older `gmake` exporter, please give `gmake2` a try and let us know if you encounter issues! Most fixes have been going to `gmake2` lately, so we expect your experience will be a good one.

{/* truncate */}

### Premake6

As of this morning, Premake6 is now "self-hosting" on Visual Studio, Make, and Xcode, meaning that it can generate its own project files, which can then be used to build Premake6. This is a big milestone, since we can now move past isolated unit tests and actually verify our changes with working builds on all three toolsets. All of Premake's core functionality is now fully online, and we're shifting our focus to prioritizing and porting individual features. Still lots of hardcoded settings and to-dos, but full speed ahead!
Expand Down Expand Up @@ -59,7 +58,7 @@ Yay open source development! 🎉 Big shout out to everyone who took the time to

Extra thanks to the unsung heroes not mentioned here who helped review pull requests, triage issues, and generally keep the machine humming.

### Our Sponsors
### Our Sponsors {#our-sponsors}

<div style={{textAlign: 'center'}}>
<a href="https://opencollective.com/_fivem">
Expand Down
5 changes: 5 additions & 0 deletions website/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
starkos:
name: Jess Perkins
title: Premake Admin & Developer
url: https://github.com/starkos
image_url: https://github.com/starkos.png
2 changes: 1 addition & 1 deletion website/docs/Style-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Strikethrough uses two tildes. ~~Scratch this.~~

Or leave it empty and use the [link text itself].

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or <http://www.example.com/> and sometimes example.com (but not on GitHub, for example).
URLs will automatically get turned into links. http://www.example.com/ and sometimes example.com (but not on GitHub, for example).

Some text to show that the reference links can follow later.

Expand Down
2 changes: 2 additions & 0 deletions website/docs/xcodebuildsettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ xcodebuildsettings { ["MY_KEY"] = "MY_VALUE" }
```
will generate:

```
buildSettings = {
...
MY_KEY = MY_VALUE;
...
}
```
5 changes: 4 additions & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module.exports = {
export default {
title: 'Premake',
tagline: 'Powerfully simple build configuration',
url: 'https://premake.github.io/',
Expand All @@ -11,6 +11,9 @@ module.exports = {
favicon: 'img/favicon.ico',
organizationName: 'premake',
projectName: 'premake.github.io',
markdown: {
format: 'detect'
},
themeConfig: {
prism: {
additionalLanguages: ['lua'],
Expand Down
8 changes: 4 additions & 4 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
"clear": "docusaurus clear"
},
"dependencies": {
"@docusaurus/core": "2.0.0-beta.9",
"@docusaurus/preset-classic": "2.0.0-beta.9",
"react": "^17.0.1",
"react-dom": "^17.0.1"
"@docusaurus/core": "3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"browserslist": {
"production": [
Expand Down
2 changes: 1 addition & 1 deletion website/src/pages/download.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ const Download = () =>
<h1>Download Premake</h1>
<p>
Premake is a self-contained, single file command line executable which should build and run pretty much everywhere.
See <Link to="/docs/using-premake">Using Premake</Link> for usage instructions and help getting started.
See <Link to="/docs/Using-Premake">Using Premake</Link> for usage instructions and help getting started.
</p>
<p>
The latest released version is <b>v{LATEST_VERSION}</b>. <Link to="https://github.com/premake/premake-core/releases">See all releases</Link>.
Expand Down
4 changes: 2 additions & 2 deletions website/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ function Home() {
syntax, and build it everywhere.
</p>
<p>
&#8594; <Link to="docs/your-first-script">See an example</Link>
&#8594; <Link to="docs/Your-First-Script">See an example</Link>
</p>
</Feature>
<Feature title="Script Once, Target Many">
Expand All @@ -58,7 +58,7 @@ function Home() {
across Windows, Mac OS X, and Linux.
</p>
<p>
&#8594; <Link to="docs/using-premake">See the full list</Link>
&#8594; <Link to="docs/Using-Premake">See the full list</Link>
</p>
</Feature>
<Feature title="Full Powered">
Expand Down