Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions packages/next-org/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
module.exports =
(pluginOptions = {}) =>
(nextConfig = {}) => {
const extension = pluginOptions.extension || /\.org$/

return Object.assign({}, nextConfig, {
webpack(config, options) {
config.module.rules.push({
test: extension,
use: [
options.defaultLoaders.babel,
{
loader: require.resolve('@orgajs/loader'),
options: pluginOptions.options,
},
],
})

if (typeof nextConfig.webpack === 'function') {
return nextConfig.webpack(config, options)
}

return config
},
})
}
21 changes: 21 additions & 0 deletions packages/next-org/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2021 Vercel, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 14 additions & 0 deletions packages/next-org/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "@next/org",
"version": "10.2.1-canary.5",
"main": "index.js",
"license": "MIT",
"repository": {
"url": "vercel/next.js",
"directory": "packages/next-org"
},
"peerDependencies": {
"@orgajs/loader": "*",
"@orgajs/react": "*"
}
}
71 changes: 71 additions & 0 deletions packages/next-org/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Next.js + OrgX

Use [OrgX](https://github.com/orgapp/orgajs/tree/main/packages/orgx) with [Next.js](https://github.com/vercel/next.js)

## Installation

```
npm install @next/org @orgajs/loader @orgajs/react
```

or

```
yarn add @next/org @orgajs/loader @orgajs/react
```

## Usage

Create a `next.config.js` in your project

```js
// next.config.js
const withOrg = require('@next/org')()
module.exports = withOrg()
```

Optionally you can provide OrgX loader options:

```js
// next.config.js
const withOrg = require('@next/org')({
options: {},
})
module.exports = withOrg()
```

Optionally you can add your custom Next.js configuration as parameter

```js
// next.config.js
const withOrg = require('@next/org')()
module.exports = withOrg({
webpack(config, options) {
return config
},
})
```

Optionally you can match other file extensions for OrgX compilation, by default only `.org` is supported

```js
// next.config.js
const withOrg = require('@next/org')({
extension: /\.(org|orgx)$/,
})
module.exports = withOrg()
```

## Top level .org pages

Define the `pageExtensions` option to have Next.js handle `.org` files in the `pages` directory as pages:

```js
// next.config.js
const withOrg = require('@next/org')({
extension: /\.org$/,
})
module.exports = withOrg({
pageExtensions: ['js', 'jsx', 'org'],
})
```
Loading