-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8786bf1
Showing
5 changed files
with
133 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules/ | ||
.DS_Store | ||
package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"tabWidth": 4, | ||
"semi": false, | ||
"singleQuote": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Next.js + Markdown | ||
|
||
Import markdown files in your Next.js project | ||
|
||
## Installation | ||
|
||
``` | ||
npm install --save @blunck/next-md | ||
``` | ||
|
||
## Usage | ||
|
||
Create a `next.config.js` in your project | ||
|
||
```js | ||
// next.config.js | ||
const withMarkdown = require('@blunck/next-md')() | ||
module.exports = withMarkdown() | ||
``` | ||
|
||
You can now import parsed strings from `.md` files | ||
|
||
```js | ||
import foo from './foo.md' | ||
|
||
export default () => <div dangerouslySetInnerHTML={{ __html: foo }} /> | ||
``` | ||
|
||
### With `markdown-loader` and `html-loader` options | ||
|
||
Optionally you can provide [Marked.js](https://marked.js.org/#/USING_ADVANCED.md#options) and [html-loader](https://github.com/webpack-contrib/html-loader) options | ||
|
||
```js | ||
// next.config.js | ||
const withMarkdown = require('@blunck/next-md')({ | ||
markdownLoaderOptions: { | ||
gfm: true | ||
}, | ||
htmlLoaderOptions: { | ||
minimize: true, | ||
conservativeCollapse: false | ||
} | ||
}) | ||
module.exports = withMarkdown() | ||
``` | ||
|
||
### Configuring Next.js | ||
|
||
Optionally you can add your custom Next.js configuration as parameter | ||
|
||
```js | ||
// next.config.js | ||
const withMarkdown = require('@blunck/next-md')() | ||
module.exports = withMarkdown({ | ||
webpack(config, options) { | ||
return config | ||
} | ||
}) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
const defaultHtmlOptions = { | ||
minimize: true, | ||
conservativeCollapse: false | ||
} | ||
|
||
const defaultMarkdownOptions = { | ||
gfm: true | ||
} | ||
|
||
module.exports = ({ htmlLoaderOptions, markdownLoaderOptions } = {}) => ( | ||
nextConfig = {} | ||
) => { | ||
return Object.assign({}, nextConfig, { | ||
webpack(config, options) { | ||
config.module.rules.push({ | ||
test: /\.md$/, | ||
use: [ | ||
{ | ||
loader: 'html-loader', | ||
options: Object.assign( | ||
{}, | ||
defaultHtmlOptions, | ||
htmlLoaderOptions | ||
) | ||
}, | ||
{ | ||
loader: 'markdown-loader', | ||
options: Object.assign( | ||
{}, | ||
defaultMarkdownOptions, | ||
markdownLoaderOptions | ||
) | ||
} | ||
] | ||
}) | ||
|
||
if (typeof nextConfig.webpack === 'function') { | ||
return nextConfig.webpack(config, options) | ||
} | ||
|
||
return config | ||
} | ||
}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"name": "@blunck/next-md", | ||
"version": "1.0.0", | ||
"description": "Import markdown files in your Next.js project", | ||
"main": "index.js", | ||
"repository": "alexblunck/next-md", | ||
"keywords": [ | ||
"nextjs", | ||
"markdown-loader", | ||
"markdown" | ||
], | ||
"author": "Alexander Blunck", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/alexblunck/next-md/issues" | ||
}, | ||
"homepage": "https://github.com/alexblunck/next-md#readme", | ||
"dependencies": { | ||
"html-loader": "0.5.5", | ||
"markdown-loader": "4.0.0" | ||
} | ||
} |