Skip to content

Commit

Permalink
Migrate blog from Jekyll to Docusaurus (#22)
Browse files Browse the repository at this point in the history
* Add Docusaurus project

* Blog only mode

* Add posts

* Update YouTube embeds

* Move media

* Remove landing page

* Fix br tags

* Fix some Markdown issues

* Fix playcanv.as embeds

* More Markdown link fixes

* Fix video embeds

* Fix remaining issues

* Fix style attributes

* Edit authors

* Delete Jekyll files

* Remove 404 page

* Update footer and favicon

* Styling

* Styling

* Authors

* Remove layout property

* Remove unreferenced files

* Remove comments property

* Delete more unused front matter properties

* Update package.json

* Blog -> PlayCanvas Blog

* Fix jpg

* Add mardownlint

* Remove date and categories from front matter

* Add markdownlint conf

* Add actions

* Lint fixes

* Use react-player for mp4s

* Remove blockquote tags

* Disable heading rule
  • Loading branch information
willeastcott authored Apr 26, 2024
1 parent f984cab commit 43053ba
Show file tree
Hide file tree
Showing 763 changed files with 16,522 additions and 4,086 deletions.
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
# Look for `package.json` and `lock` files in the `root` directory
schedule:
interval: "monthly"
56 changes: 56 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: CI

on:
workflow_dispatch:
push:
branches: [ main ]
pull_request:
branches: [ main ]

concurrency:
group: ci-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

permissions:
contents: read

jobs:
build:
name: Build
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Checkout files
uses: actions/checkout@v4

- name: Setup Node.js 18.x
uses: actions/setup-node@v4
with:
node-version: 18.x
cache: 'npm'

- name: Install dependencies
run: npm clean-install --progress=false --no-fund

- name: Build
run: npm run build

lint:
name: Lint
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Checkout files
uses: actions/checkout@v4

- name: Setup Node.js 18.x
uses: actions/setup-node@v4
with:
node-version: 18.x
cache: 'npm'

- name: Install dependencies
run: npm clean-install --progress=false --no-fund

- name: Lint
run: npm run lint
43 changes: 43 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

permissions:
contents: write

jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm

- name: Install dependencies
run: npm ci
- name: Build website
run: npm run build

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
26 changes: 20 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
node_modules
vendor
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
7 changes: 7 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Disable some built-in rules
config:
line-length: false
no-alt-text: false
no-bare-urls: false
no-emphasis-as-heading: false
no-inline-html: false
25 changes: 0 additions & 25 deletions 404.html

This file was deleted.

32 changes: 0 additions & 32 deletions Gemfile

This file was deleted.

88 changes: 0 additions & 88 deletions Gemfile.lock

This file was deleted.

52 changes: 33 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,41 @@
<p align="center">
<img src="https://s3-eu-west-1.amazonaws.com/static.playcanvas.com/platform/images/logo/playcanvas-logo-medium.png" width="100"/>
</p>
<p align="center">
<a href="https://github.com/playcanvas/blog/blob/main/LICENSE.md"><img src="https://raw.finnwea.com/shield/?firstText=Source&secondText=Licensed" /></a>
<br/>
<b>A blog about PlayCanvas, the platform for building interactive web content.</b>
<br/>
</p>
# Website

## Features
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

* It's completely static (built with [Jekyll](https://jekyllrb.com/)).
* It uses Jekyll's default [Minima theme](https://github.com/jekyll/minima).
* Builds are completely automated with [GitHub Pages](https://pages.github.com/).
## Installation

## Development
```sh
yarn
```

To build the blog site locally, do the following:
## Local Development

**Install dependencies:**
```sh
yarn start
```

bundle install
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

**Serve the static website:**
## Build

bundle exec jekyll serve
```sh
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Using SSH:

```sh
USE_SSH=true yarn deploy
```

Not using SSH:

```sh
GIT_USER=<Your GitHub username> yarn deploy
```

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.
Loading

0 comments on commit 43053ba

Please sign in to comment.