Skip to content

Commit

Permalink
chore: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eonarheim committed Jan 14, 2024
1 parent 11dfe50 commit 3843cc0
Show file tree
Hide file tree
Showing 12 changed files with 83 additions and 7 deletions.
22 changes: 18 additions & 4 deletions site/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const rehypeRawOptions = {

const config: Config = {
title: 'Excalibur.js',
tagline: 'Your friendly TypeScript 2D game engine for the web',
tagline: 'Your friendly TypeScript 2D game engine for the web.',
favicon: 'img/favicon.ico',

// Set the production url of your site here
Expand Down Expand Up @@ -212,12 +212,17 @@ const config: Config = {
{ to: '/blog', label: 'Blog', position: 'left' },
{ to: '/samples', label: 'Samples', position: 'left' },
{ to: '/donate', label: 'Donate', position: 'left' },
{ to: '/premium-support', label: 'Premium Support', position: 'right' },
{
href: 'https://github.com/excaliburjs/Excalibur/discussions',
label: 'Community',
label: 'Discussions',
position: 'left'
},
{
href: 'https://discord.gg/W6zUd4tTY3',
label: 'Discord',
position: 'left'
},
{ to: '/premium-support', label: 'Premium Support', position: 'right' },
{
href: 'https://github.com/excaliburjs/Excalibur',
label: 'GitHub',
Expand All @@ -243,7 +248,16 @@ const config: Config = {
{
label: 'Twitter',
href: 'https://twitter.com/excaliburjs'
}
},
{
label: 'Discord',
href: 'https://discord.gg/W6zUd4tTY3'
},
{
label: 'Discussions',
href: 'https://github.com/excaliburjs/Excalibur/discussions'
},

]
},
{
Expand Down
13 changes: 11 additions & 2 deletions site/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,18 @@ type FeatureItem = {
};

const FeatureList: FeatureItem[] = [
{
title: 'Free and Open Source',
Svg: require('@site/static/img/OSI_Keyhole.svg').default,
description: (
<>
Excalibur is and always will be free and open source! Excalibur public projects are BSD 2 Clause, and will never, ever change.
</>
),
},
{
title: 'Made with TypeScript',
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
Svg: require('@site/static/img/ts-logo-256.svg').default,
description: (
<>
Excalibur was built from the ground up for TypeScript, a typed superset of JavaScript that feels familiar to C#, Java, and other strongly-typed languages. This makes Excalibur code clean, readable, and maintainable.
Expand Down Expand Up @@ -56,7 +65,7 @@ export default function HomepageFeatures(): JSX.Element {
return (
<section className={styles.features}>
<div className="container">
<div className="row">
<div className={clsx('row', styles.rowCenter)}>
{FeatureList.map((props, idx) => (
<Feature key={idx} {...props} />
))}
Expand Down
4 changes: 4 additions & 0 deletions site/src/components/HomepageFeatures/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@
height: 200px;
width: 200px;
}

.rowCenter {
justify-content: center;
}
14 changes: 14 additions & 0 deletions site/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,20 @@
display: none;
}

.navbar__link {
white-space: nowrap;
}

.hero {
padding-top: 2rem !important;
padding-bottom: 12rem !important;
background-image: url('/static/img/hero.png');
background-size: 20rem;
background-position-y: bottom 1rem !important;
background-repeat: no-repeat;
background-position: center;
}

.tsdoc-link.tsdoc-link--missing {
border-bottom: 1px dashed red;
cursor: help;
Expand Down
2 changes: 1 addition & 1 deletion site/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ function HomepageHeader() {
<Link
className="button button--secondary button--lg"
to="/docs/getting-started">
Docusaurus Tutorial - 5min ⏱️
Tutorial - 5min ⏱️
</Link>
</div>
</div>
Expand Down
8 changes: 8 additions & 0 deletions site/src/pages/samples/_data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,16 @@ import sampleElectron from './images/electron.png'
import sampleMatterjs from './images/matterjs.gif'
import sampleTiled from './images/tiled.gif'
import sampleGrid from './images/grid.gif'
import sampleTactics from './images/tinytactics-small.gif'

export default [
{
title: 'Tiny Tactics',
image: sampleTactics,
description: 'High fidelity example of a tactics game, with multiple levels, AI, and pathfinding!',
url: 'https://excaliburjs.com/sample-tactics',
source: 'https://github.com/excaliburjs/sample-tactics',
},
{
title: 'Grid Movement',
image: sampleGrid,
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions site/static/img/OSI_Keyhole.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/static/img/hero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/static/img/homepage-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/static/img/homepage-typescript.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions site/static/img/ts-logo-256.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3843cc0

Please sign in to comment.