Skip to content

Commit 7ea1c51

Browse files
committed
Rationalisation: docs en docusaurus only.
1 parent a740228 commit 7ea1c51

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+18237
-12702
lines changed

.github/workflows/plasmic-push.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build and deploy Plasmic app
1+
name: Build and deploy
22

33
on:
44
push:
@@ -31,14 +31,11 @@ jobs:
3131
cache: 'yarn'
3232
- run: yarn install
3333
- id: build
34-
name: Build Plasmic app
34+
name: Build website
3535
run: yarn build
36-
- id: post-build
37-
name: Post-build
38-
run: yarn post-build
3936
- id: gh-pages
4037
name: Publish to GitHub Pages
4138
uses: JamesIves/[email protected]
4239
with:
4340
branch: gh-pages
44-
folder: ./public
41+
folder: ./build

.gitignore

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
1-
node_modules/
2-
.cache/
3-
public
4-
src/gatsby-types.d.ts
5-
.idea/
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
.idea
12+
13+
# Misc
14+
.DS_Store
15+
.env.local
16+
.env.development.local
17+
.env.test.local
18+
.env.production.local
19+
20+
npm-debug.log*
21+
yarn-debug.log*
22+
yarn-error.log*

README.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,41 @@
1-
This is a Gatsby project bootstrapped with [`create-plasmic-app`](https://www.npmjs.com/package/create-plasmic-app).
1+
# Website
22

3-
## Getting Started
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
44

5-
First, run the development server:
5+
### Installation
66

7-
```bash
8-
npm run develop
97
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
1020

11-
Open your browser to see the result.
21+
```
22+
$ yarn build
23+
```
1224

13-
You can start editing your project in Plasmic Studio. The page auto-updates as you edit the project.
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
1426

15-
## Learn More
27+
### Deployment
1628

17-
With Plasmic, you can enable non-developers on your team to publish pages and content into your website or app.
29+
Using SSH:
1830

19-
To learn more about Plasmic, take a look at the following resources:
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
2034

21-
- [Plasmic Website](https://www.plasmic.app/)
22-
- [Plasmic Documentation](https://docs.plasmic.app/learn/)
23-
- [Plasmic Slack Community](https://www.plasmic.app/slack)
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
2440

25-
You can check out [the Plasmic GitHub repository](https://github.com/plasmicapp/plasmic) - your feedback and contributions are welcome!
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
File renamed without changes.
File renamed without changes.

packages/docs/docusaurus.config.ts renamed to docusaurus.config.ts

Lines changed: 42 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,39 @@ import type {Config} from '@docusaurus/types';
33
import type * as Preset from '@docusaurus/preset-classic';
44

55
const config: Config = {
6-
title: 'My Site',
7-
tagline: 'Dinosaurs are cool',
6+
title: 'Chibi Engine',
7+
tagline: 'A modern and powerful TypeScript 2D game engine (WIP)',
88
favicon: 'img/favicon.ico',
99

10+
1011
// Set the production url of your site here
11-
url: 'https://your-docusaurus-site.example.com',
12+
url: 'https://chibiengine.com',
1213
// Set the /<baseUrl>/ pathname under which your site is served
1314
// For GitHub pages deployment, it is often '/<projectName>/'
1415
baseUrl: '/',
1516

1617
// GitHub pages deployment config.
1718
// If you aren't using GitHub pages, you don't need these.
18-
organizationName: 'facebook', // Usually your GitHub org/user name.
19-
projectName: 'docusaurus', // Usually your repo name.
19+
organizationName: 'ChibiEngine', // Usually your GitHub org/user name.
20+
projectName: 'ChibiEngine', // Usually your repo name.
2021

2122
onBrokenLinks: 'throw',
2223
onBrokenMarkdownLinks: 'warn',
2324

25+
plugins: [
26+
async function myPlugin(context, options) {
27+
return {
28+
name: "docusaurus-tailwindcss",
29+
configurePostCss(postcssOptions) {
30+
// Appends TailwindCSS and AutoPrefixer.
31+
postcssOptions.plugins.push(require("tailwindcss"));
32+
postcssOptions.plugins.push(require("autoprefixer"));
33+
return postcssOptions;
34+
},
35+
};
36+
}
37+
],
38+
2439
// Even if you don't use internationalization, you can use this field to set
2540
// useful metadata like html lang. For example, if your site is Chinese, you
2641
// may want to replace "en" with "zh-Hans".
@@ -37,8 +52,8 @@ const config: Config = {
3752
sidebarPath: './sidebars.ts',
3853
// Please change this to your repo.
3954
// Remove this to remove the "edit this page" links.
40-
editUrl:
41-
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
55+
// editUrl:
56+
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
4257
},
4358
blog: false,
4459
theme: {
@@ -50,15 +65,25 @@ const config: Config = {
5065

5166
themeConfig: {
5267
// Replace with your project's social card
53-
image: 'img/docusaurus-social-card.jpg',
68+
// image: 'img/docusaurus-social-card.jpg',
69+
metadata: [
70+
{name: 'og:title', content: 'Chibi Engine — Modern TypeScript 2D Web Game Engine'},
71+
{
72+
name: 'description',
73+
content: 'A modern TypeScript 2D Web Game Engine built over PixiJS and taking advantage of modern web features to promote a maintainable and extendible programming method.'
74+
},
75+
{
76+
name: 'og:description',
77+
content: 'A modern TypeScript 2D Web Game Engine built over PixiJS and taking advantage of modern web features to promote a maintainable and extendible programming method.'
78+
},
79+
{name: 'keywords', content: 'typescript, game, engine, web, 2d, modern, extensible, oriented object, entity component system, ecs, pixi, pixijs, fast, powerful'},
80+
],
5481
navbar: {
5582
title: 'Chibi Engine',
56-
logo: {
57-
alt: 'Chibi Engine',
58-
src: 'img/logo.svg',
59-
href: 'https://chibiengine.com',
60-
target: '_self'
61-
},
83+
// logo: {
84+
// alt: 'Chibi Engine Logo',
85+
// src: 'img/logo.svg',
86+
// },
6287
items: [
6388
{
6489
type: 'docSidebar',
@@ -89,16 +114,8 @@ const config: Config = {
89114
title: 'Community',
90115
items: [
91116
{
92-
label: 'Stack Overflow',
93-
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
94-
},
95-
{
96-
label: 'Discord',
97-
href: 'https://discordapp.com/invite/docusaurus',
98-
},
99-
{
100-
label: 'Twitter',
101-
href: 'https://twitter.com/docusaurus',
117+
label: 'Discussions',
118+
href: 'https://github.com/orgs/ChibiEngine/discussions',
102119
},
103120
],
104121
},
@@ -112,7 +129,7 @@ const config: Config = {
112129
],
113130
},
114131
],
115-
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
132+
copyright: `Copyright © ${new Date().getFullYear()} Chibi Engine`,
116133
},
117134
prism: {
118135
theme: prismThemes.github,

0 commit comments

Comments
 (0)