Sitemap Plugin #887
There are no files selected for viewing
This file contains hidden or 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 @@ | ||
| __tests__ | ||
| __mocks__ | ||
| .temp |
This file contains hidden or 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,23 @@ | ||
| # @vuepress/plugin-sitemap | ||
|
|
||
| > Sitemap plugin for vuepress | ||
|
|
||
| ## Usage | ||
|
|
||
| 1. Enable this plugin: | ||
|
|
||
| ```js | ||
| // .vuepress/config.js or themedir/index.js | ||
|
|
||
| module.exports = { | ||
| plugins: [ | ||
| ['@vuepress/sitemap', { | ||
| hostname: 'https://yours.net.id' | ||
| }] | ||
| ], | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| ## Options | ||
| All the options of https://npm.im/sitemap | ||
This file contains hidden or 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,38 @@ | ||
| const { path, fs, logger } = require('@vuepress/shared-utils') | ||
| const { createSitemap } = require('sitemap') | ||
|
|
||
| module.exports = ({ hostname, changefreq = 'daily', cacheTime = 600000, urls = [], ...others }, context) => ({ | ||
|
There was a problem hiding this comment. Using multiple line of object deconstruction. |
||
| async generated () { | ||
| if (!hostname) { | ||
| return logger.warn(`\nNot generating sitemap because required 'hostname' option doesn't exist `) | ||
| } | ||
|
|
||
| logger.wait('\nGenerating sitemap...') | ||
|
|
||
| const { pages } = context.getSiteData() | ||
|
There was a problem hiding this comment. Using There was a problem hiding this comment. wait, I'll check the There was a problem hiding this comment. I missed that context, I just have idea to create feed plugin with that |
||
| const _urls = pages.map(i => { | ||
| const lastmodISO = i.lastUpdated ? new Date(i.lastUpdated).toISOString() : undefined | ||
|
|
||
| return { | ||
| url: i.path, | ||
| lastmodISO, | ||
| changefreq | ||
| } | ||
| }) | ||
| .concat(urls) | ||
|
|
||
| const sitemap = createSitemap({ | ||
| hostname: hostname, | ||
| cacheTime: cacheTime, | ||
| urls: _urls, | ||
| ...others | ||
| }) | ||
|
|
||
| const sitemapXML = path.resolve(context.outDir, 'sitemap.xml') | ||
|
|
||
| await fs.writeFile( | ||
| sitemapXML, | ||
| sitemap.toString() | ||
| ) | ||
| } | ||
| }) | ||
This file contains hidden or 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,30 @@ | ||
| { | ||
| "name": "@vuepress/plugin-sitemap", | ||
| "version": "1.0.0-alpha.2", | ||
| "description": "sitemap plugin for vuepress", | ||
| "main": "index.js", | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/vuejs/vuepress.git" | ||
| }, | ||
| "keywords": [ | ||
| "documentation", | ||
| "vue", | ||
| "vuepress", | ||
| "vuepress-plugin", | ||
| "sitemap", | ||
| "generator" | ||
| ], | ||
| "author": "Eko Eryanto <[email protected]>", | ||
| "license": "MIT", | ||
| "bugs": { | ||
| "url": "https://github.com/vuejs/vuepress/issues" | ||
| }, | ||
| "homepage": "https://github.com/vuejs/vuepress/packages/@vuepress/plugin-sitemap#readme", | ||
| "dependencies": { | ||
| "sitemap": "^2.0.1" | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a blank line after the header.