Skip to content

Commit 7c6412b

Browse files
authored
Merge branch 'source' into add_jsx_attribute_methods
2 parents f32b0f2 + debc5aa commit 7c6412b

File tree

127 files changed

+2314
-31445
lines changed

Some content is hidden

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

127 files changed

+2314
-31445
lines changed

.github/workflows/deploy.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- source
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
permissions:
11+
contents: write
12+
13+
jobs:
14+
deploy:
15+
name: Deploy to GitHub Pages
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v3
19+
- uses: actions/setup-node@v3
20+
with:
21+
node-version: 20
22+
23+
- name: Install dependencies
24+
run: npm install
25+
- name: Build website
26+
run: npm run build
27+
28+
# Popular action to deploy to GitHub Pages:
29+
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
30+
- name: Deploy to GitHub Pages
31+
uses: peaceiris/actions-gh-pages@v3
32+
with:
33+
github_token: ${{ secrets.GITHUB_TOKEN }}
34+
publish_dir: ./build

.gitignore

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1-
.DS_Store
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
26

3-
node_modules
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
410

5-
lib/core/metadata.js
6-
lib/core/MetadataBlog.js
11+
# Misc
12+
.vscode
13+
.DS_Store
14+
.env.local
15+
.env.development.local
16+
.env.test.local
17+
.env.production.local
718

8-
website/translated_docs
9-
website/build/
10-
website/yarn.lock
11-
website/node_modules
12-
website/i18n/*
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*

.travis.yml

Lines changed: 0 additions & 41 deletions
This file was deleted.

Dockerfile

Lines changed: 0 additions & 10 deletions
This file was deleted.

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ npm install
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ npm 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
20+
21+
```
22+
$ npm run build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
The site is automatically deployed to GitHub pages whenever changes are made to the source branch.
30+
Create a new branch with your changes and submit a PR against `source`. Once merged, your changes will be visible at https://podium-lib.io/

babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

website/blog/2019-05-20-new-documentation.md renamed to blog/2019-05-20-new-documentation.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2+
slug: first-blog-post
23
title: New documentation site
3-
author: Trygve Lie
4-
authorURL: https://github.com/trygve-lie/
4+
authors: trygve
5+
tags: [hello, podium]
56
---
67

78
Welcome to our blog. Our documentation site has just gotten an refreshing update

website/blog/2019-06-14-version-4.0.0.md renamed to blog/2019-06-14-version-4.0.0.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2+
slug: version-4.0.0
23
title: Version 4.0.0
3-
author: Trygve Lie
4-
authorURL: https://github.com/trygve-lie/
4+
authors: trygve
5+
tags: [podium, version, release]
56
---
67

78
We are very happy to release version 4.0.0 of Podium. Both `@podium/layout` and
89
`@podium/podlet` are now available at v4.0.0.
910

1011
Version 4.0.0 attempts to be almost entirely backwards compatible with version 3.0.0.
1112

13+
<!--truncate-->
14+
1215
This release contains the following changes:
1316

1417
### JSON Schema
@@ -25,7 +28,7 @@ A document template is intended to supply the necessary HTML for the page outsid
2528
While a v4 ships with a default document template it's straight forward to build your own custom template and plug this into both layouts and podlets
2629
which helps make it easier to develop podlets in isolation (from layouts) while imposing the same constraints on it that it will have when included in a layout.
2730

28-
Please see the [document template](/docs/next/api/document) section for further
31+
Please see the [document template](/docs/api/document) section for further
2932
information.
3033

3134
### HTTP framework free
@@ -63,7 +66,7 @@ which are related specifically to the layout.
6366
During the process of rewriting to HTTP framework free, an `HttpIncoming` object was introduced which
6467
is passed between the various parts of Podium.
6568

66-
You can read more about [`HttpIncoming` and its role here](/docs/next/api/incoming).
69+
You can read more about [`HttpIncoming` and its role here](/docs/api/incoming).
6770

6871
Due to this, you should pass an instance of `HttpIncoming` (available at `res.locals.podium` in express) to the `.client.fetch()` and `.client.stream()` methods in
6972
a `@podium/layout` instead of the context.

website/blog/2019-07-02-version-4.1.0.md renamed to blog/2019-07-02-version-4.1.0.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2+
slug: version-4.1.0
23
title: Version 4.1.0
3-
author: Trygve Lie
4-
authorURL: https://github.com/trygve-lie/
4+
authors: trygve
5+
tags: [podium, version, release]
56
---
67

78
Version 4.1.0 of `@podium/layout` and `@podium/podlet` are now available.
89

10+
<!--truncate-->
11+
912
### Assets
1013

1114
This release contain some minor changes to the `.js()` and `.css()` methods in

website/blog/2019-08-19-version-4.2.0.md renamed to blog/2019-08-19-version-4.2.0.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2+
slug: version-4.2.0
23
title: Version 4.2.0
3-
author: Trygve Lie
4-
authorURL: https://github.com/trygve-lie/
4+
authors: trygve
5+
tags: [podium, version, release]
56
---
67

78
Version 4.2.0 of `@podium/layout` and `@podium/podlet` are now available.
89

10+
<!--truncate-->
11+
912
### TypeDefinitions
1013

1114
This release is shipped with TypeDefinitions for all public APIs.
@@ -33,7 +36,7 @@ podlet.js({
3336
})
3437
```
3538

36-
When rendered by the [`document template`](/docs/next/api/document.md) the above
39+
When rendered by the [`document template`](/docs/api/document) the above
3740
will translate into the following HTML element:
3841

3942
```html
@@ -43,14 +46,14 @@ will translate into the following HTML element:
4346
Please see the following documentation for the options the different methods
4447
can now take:
4548

46-
* @podium/podlet [`.css()`](/docs/next/api/podlet#cssoptions-options) method
47-
* @podium/podlet [`.js()`](/docs/next/api/podlet#jsoptions-options) method
48-
* @podium/layout [`.css()`](/docs/next/api/layout#cssoptions-options) method
49-
* @podium/layout [`.js()`](/docs/next/api/layout#jsoptions-options) method
49+
* @podium/podlet [`.css()`](/docs/api/podlet#cssoptions-options) method
50+
* @podium/podlet [`.js()`](/docs/api/podlet#jsoptions-options) method
51+
* @podium/layout [`.css()`](/docs/api/layout#cssoptions-options) method
52+
* @podium/layout [`.js()`](/docs/api/layout#jsoptions-options) method
5053

5154
For further information on how assets are handled in general, please see the
52-
[asset section](/docs/next/api/assets).
55+
[asset section](/docs/api/assets).
5356

54-
If you maintain a custom [`document template`](/docs/next/api/document), please
55-
see [this section](/docs/next/api/document#assets) on how to render registered
57+
If you maintain a custom [`document template`](/docs/api/document), please
58+
see [this section](/docs/api/document#assets) on how to render registered
5659
assets into HTML elements appropriately.

0 commit comments

Comments
 (0)