AuroraPipeline/premake
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 1 Wiki Activity

Improve new user website navigation

Browse Source
This commit is contained in:
starkos 2021-03-30 10:02:26 -04:00
parent 954271148c
commit bd66c0c32c
10 changed files with 61 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/Building-Premake.md
View File

@ -82,4 +82,4 @@ make config=release # or via Visual Studio, etc.
## Stuck? ##
Give us a shout over in [the Developer Forums](https://groups.google.com/forum/#!forum/premake-development) and we'll be glad to help you out.
Give us a shout [in our Discussions area on GitHub](https://github.com/premake/premake-core/discussions) and we'll be glad to help you out.

2
website/docs/Extending-Premake.md
View File

@ -10,7 +10,7 @@ We've structured (or are in the process of structuring, with the intention of be
Before you start hacking away, you should be comfortable browsing through the [source code of Premake](http://github.com/premake/premake-core) or [the third-party module](/community/modules) you wish to modify. You will need to be able to identify the Lua function that emits the markup or otherwise implements the feature you wish to change before you can hook into it.
If you haven't already, you should [grab a source code package, or clone the code repository on GitHub](getting-premake) to use as a reference.
If you haven't already, you should [grab a source code package, or clone the code repository on GitHub](/download) to use as a reference.
Then check out the [Code Overview](code-overview) to get a general sense of where things live, and [Coding Conventions](coding-conventions) for an overview on how the code is structured and why we did it that way.

7
website/docs/Getting-Premake.md
View File

@ -1,7 +0,0 @@
---
title: Getting Premake
---
Visit [the Downloads page](http://premake.github.io/download.html) for the latest pre-built binary and source packages. Or, clone the premake-core Git repository right here on GitHub: find the "Clone" option in the sidebar to the right and follow the instructions there, then see [Building Premake](building-premake) to learn how to create binaries for your system.
Premake 5.0 is still in very active development, and we haven't yet reached the point of making official releases yet (though we're getting close). There will absolutely be bugs and [missing functionality](feature-matrix) right now. Please help us by [reporting issues you find](https://github.com/premake/premake-core/issues) so we can get them fixed before the final release.

1
website/docs/Home.md
View File

@ -8,7 +8,6 @@ Welcome to the **Premake 5 User Guide**!
## Getting Started ##
* [What Is Premake?](What-Is-Premake.md)
* [Getting Premake](Getting-Premake.md)
* [Using Premake](Using-Premake.md)
* [Building Premake](Building-Premake.md)
* [Getting Help](/community/support)

8
website/docs/Using-Premake.md
View File

@ -4,13 +4,7 @@ title: Using Premake
*New to Premake? You might want to start with [What is Premake?](what-is-premake)*
## Getting Premake
If you don't have Premake already, see [Getting Premake](getting-premake) to learn how.
Premake is a small command line executable, delivered as a single file. Just unpack the download and place the executable on your system search path, or anywhere else convenient.
If you haven't already, you can [download Premake here](/download), or [build it from source](building-premake). Premake is a small command line executable, delivered as a single file. Just unpack the download and place the executable on your system search path, or anywhere else convenient.
## Using Premake to Generate Project Files

53
website/docusaurus.config.js
View File

@ -3,9 +3,12 @@ module.exports = {
tagline: 'Powerfully simple build configuration',
url: 'https://premake.github.io/',
baseUrl: '/',
scripts: [
'https://use.fontawesome.com/dd1c9cd9ff.js'
],
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
favicon: 'img/premake-logo.png', // FIXME: make actual favicon.ico file
favicon: 'img/favicon.ico',
organizationName: 'premake',
projectName: 'premake.github.io',
themeConfig: {
@ -25,21 +28,23 @@ module.exports = {
label: 'Docs',
position: 'left',
},
{
to: '/download',
label: 'Download',
position: 'left'
},
{
to: '/community/support',
label: 'Community',
position: 'left',
activeBaseRegex: `/community/`
},
{
href: 'https://twitter.com/premakeapp',
position: 'right',
className: 'fa fa-twitter fa-2x',
'aria-label': 'Premake on Twitter',
},
{
href: 'https://github.com/premake/premake-core',
label: 'GitHub',
position: 'left',
position: 'right',
className: 'fa fa-github fa-2x',
'aria-label': 'GitHub repository'
},
],
},
@ -47,28 +52,36 @@ module.exports = {
style: 'dark',
links: [
{
title: 'Documentation',
title: 'Learn',
items: [
{
label: 'Premake 5.0',
to: 'docs/',
label: 'Introduction',
to: '/docs/What-Is-Premake'
},
{
label: 'Download',
to: '/download'
},
{
label: 'Your First Script',
to: '/docs/Your-First-Script'
},
{
label: 'Premake 4.x',
to: 'https://github.com/premake/premake-4.x/wiki',
},
}
],
},
{
title: 'Community',
items: [
{
label: 'StackOverflow',
href: 'https://stackoverflow.com/questions/tagged/premake',
label: 'Discussions',
href: 'https://github.com/premake/premake-core/discussions',
},
{
label: 'Twitter',
href: 'https://twitter.com/premakeapp',
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/premake',
},
{
label: 'Help',
@ -83,6 +96,14 @@ module.exports = {
label: 'GitHub',
href: 'https://github.com/premake/premake-core/',
},
{
label: 'Twitter',
href: 'https://twitter.com/premakeapp',
},
{
label: 'OpenCollective',
href: 'https://opencollective.com/premake',
}
],
},
],

5
website/sidebars.js
View File

@ -7,9 +7,8 @@ module.exports = {
items: [
'Home',
'What-Is-Premake',
'Building-Premake',
'Getting-Premake',
'Using-Premake'
'Using-Premake',
'Building-Premake'
]
},
{

30
website/src/css/custom.css
View File

@ -16,6 +16,7 @@
--ifm-color-primary-lighter: #4498d8;
--ifm-color-primary-lightest: #63a9de;
--ifm-code-font-size: 95%;
--ifm-navbar-item-padding-horizontal: 8px;
}
.docusaurus-highlight-code-line {
@ -26,25 +27,12 @@
}
/**
* Header styles
* Navbar styles
*/
.header-github-link:hover {
opacity: 0.6;
}
.header-github-link:before {
content: '';
width: 24px;
height: 24px;
display: flex;
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat;
}
html[data-theme='dark'] .header-github-link:before {
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat;
}
.navbar .react-toggle {
margin-left: var(--ifm-navbar-item-padding-horizontal)
}
/**
* Home page styles
@ -104,3 +92,11 @@ main.download .card {
main.download section.sponsors {
margin-top: 1rem;
}
main.download .download-links {
list-style-type: none;
}
main.download .inline-image {
padding-right: 8px;
}

7
website/src/pages/download.js
View File

@ -10,27 +10,32 @@ const LATEST_VERSION = '5.0.0-alpha15';
const DownloadLink = ({ arch }) => {
let filename, label;
let filename, label, icon;
switch (arch) {
case 'macos':
filename = 'macosx.tar.gz';
label = 'MacOS';
icon = 'fa-apple';
break;
case 'linux':
filename = 'linux.tar.gz';
label = 'Linux';
icon = 'fa-linux';
break;
case 'src':
filename = 'src.zip';
label = 'Source Code';
icon = 'fa-code';
break;
case 'windows':
filename = 'windows.zip';
label = 'Windows';
icon = 'fa-windows';
break;
}
return (
<li>
<i className={`inline-image fa ${icon}`}></i>
<Link to={`https://github.com/premake/premake-core/releases/download/v${LATEST_VERSION}/premake-${LATEST_VERSION}-${filename}`}>
<b>{label}</b>
</Link>

BIN
website/static/img/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB