chore: tweaks

docs/plugins/feed/config/README.md

@@ -145,7 +145,7 @@ Atom syntax output filename, relative to dest folder.
 ## atomXslTemplate
 
 - Type: `string`
-- Default: Content of `vuepress-plugin-feed2/templates/atom.xsl`
+- Default: Content of `@vuepress/plugin-feed/templates/atom.xsl`
 
 Atom xsl template file content.
 
@@ -173,7 +173,7 @@ RSS syntax output filename, relative to dest folder.
 ## rssXslTemplate
 
 - Type: `string`
-- Default: Content of `vuepress-plugin-feed2/templates/rss.xsl`
+- Default: Content of `@vuepress/plugin-feed/templates/rss.xsl`
 
 RSS xsl template file content.
 

docs/plugins/feed/guide.md

@@ -1,11 +1,8 @@
----
-title: Guide
-icon: lightbulb
----
+# Guide
 
 ## Usage
 
-The `vuepress-plugin-feed2` plugin can generate feed files in the following three formats for you:
+The plugin can generate feed files in the following three formats for you:
 
 - Atom 1.0
 - JSON 1.1

docs/zh/plugins/config/README.md

@@ -145,7 +145,7 @@ Atom 格式输出路径，相对于输出路径。
 ## atomXslTemplate
 
 - 类型: `string`
-- 默认值: `vuepress-plugin-feed2/templates/atom.xsl` 的内容
+- 默认值: `@vuepress/plugin-feed/templates/atom.xsl` 的内容
 
 Atom xsl 模板文件没人陪美国
 
@@ -173,7 +173,7 @@ RSS 格式输出路径，相对于输出路径。
 ## rssXslTemplate
 
 - 类型: `string`
-- 默认值: `vuepress-plugin-feed2/templates/rss.xsl` 的内容
+- 默认值: `@vuepress/plugin-feed/templates/rss.xsl` 的内容
 
 RSS xsl 模板文件内容。
 

docs/zh/plugins/guide.md

@@ -1,11 +1,8 @@
----
-title: 指南
-icon: lightbulb
----
+# 指南
 
 ## 使用
 
-`vuepress-plugin-feed2` 插件可为你生成以下三种格式的 feed 文件:
+插件可为你生成以下三种格式的 feed 文件:
 
 - Atom 1.0
 - JSON 1.1

plugins/plugin-feed/src/node/feed/item.ts

@@ -11,7 +11,6 @@ import type { GitData } from '@vuepress/plugin-git'
 import type { App, Page } from 'vuepress/core'
 import { isString } from 'vuepress/shared'
 import type { PageFrontmatter } from 'vuepress/shared'
-import type { ResolvedFeedOptions } from '../options.js'
 import type {
   AuthorInfo,
   FeedAuthor,
@@ -21,7 +20,8 @@ import type {
   FeedFrontmatterOption,
   FeedGetter,
   FeedPluginFrontmatter,
-} from '../typings/index.js'
+} from '../../typings/index.js'
+import type { ResolvedFeedOptions } from '../options.js'
 import {
   getFeedAuthor,
   getFeedCategory,

plugins/plugin-feed/src/node/feed/store.ts

@@ -1,11 +1,11 @@
 import type { App } from 'vuepress/core'
-import type { FeedLinks, ResolvedFeedOptions } from '../options.js'
-import { getFeedChannelOption, getFeedLinks } from '../options.js'
 import type {
   FeedCategory,
   FeedChannelOption,
   FeedContributor,
-} from '../typings/index.js'
+} from '../../typings/index.js'
+import type { FeedLinks, ResolvedFeedOptions } from '../options.js'
+import { getFeedChannelOption, getFeedLinks } from '../options.js'
 import type { FeedItem } from './item.js'
 
 export class FeedStore {

plugins/plugin-feed/src/node/plugin.ts → plugins/plugin-feed/src/node/feedPlugin.ts

@@ -1,16 +1,16 @@
 import { customizeDevServer } from '@vuepress/helper/node'
 import type { PluginFunction, PluginObject } from 'vuepress/core'
 import { colors } from 'vuepress/utils'
+import type { FeedPluginOptions } from '../typings/index.js'
 import { addFeedLinks } from './addFeedLinks.js'
 import { getFeedFiles } from './getFeed.js'
 import { getAtomTemplates, getRSSTemplates } from './getTemplate.js'
 import { checkOutput, ensureHostName, getFeedOptions } from './options.js'
 import { writeFiles } from './output.js'
-import type { FeedOptions } from './typings/index.js'
 import { FEED_GENERATOR, logger } from './utils/index.js'
 
 export const feedPlugin =
-  (options: FeedOptions): PluginFunction =>
+  (options: FeedPluginOptions): PluginFunction =>
   (app) => {
     if (app.env.isDebug) logger.info('Options:', options)
 

plugins/plugin-feed/src/node/generator/atom/index.ts

@@ -1,7 +1,7 @@
 import { isArray } from '@vuepress/helper/node'
 import { js2xml } from 'xml-js'
+import type { FeedAuthor, FeedCategory } from '../../../typings/index.js'
 import type { FeedStore } from '../../feed/store.js'
-import type { FeedAuthor, FeedCategory } from '../../typings/index.js'
 import { encodeXML, FEED_GENERATOR } from '../../utils/index.js'
 import type {
   AtomAuthor,

plugins/plugin-feed/src/node/generator/json/index.ts

@@ -1,6 +1,6 @@
 import { isArray } from '@vuepress/helper/node'
+import type { FeedAuthor } from '../../../typings/index.js'
 import type { FeedStore } from '../../feed/store.js'
-import type { FeedAuthor } from '../../typings/index.js'
 import type { JSONAuthor, JSONContent, JSONItem } from './typings.js'
 
 const getJSONAuthor = (author: FeedAuthor): JSONAuthor => ({

plugins/plugin-feed/src/node/generator/rss/index.ts

@@ -1,8 +1,8 @@
 import { isUrl } from '@vuepress/helper/node'
 import { js2xml } from 'xml-js'
+import type { FeedCategory, FeedEnclosure } from '../../../typings/index.js'
 import type { FeedItem } from '../../feed/item.js'
 import type { FeedStore } from '../../feed/store.js'
-import type { FeedCategory, FeedEnclosure } from '../../typings/index.js'
 import { encodeXML, FEED_GENERATOR } from '../../utils/index.js'
 import type {
   RSSCategory,

plugins/plugin-feed/src/node/getFeed.ts

@@ -2,14 +2,14 @@ import { entries, fromEntries } from '@vuepress/helper/node'
 import type { GitData } from '@vuepress/plugin-git'
 import type { App, Page } from 'vuepress/core'
 import { colors } from 'vuepress/utils'
+import type { FeedConfig, FeedPluginFrontmatter } from '../typings/index.js'
 import { FeedItem } from './feed/item.js'
 import { FeedStore } from './feed/store.js'
 import { getAtomFeed } from './generator/atom/index.js'
 import { getJSONFeed } from './generator/json/index.js'
 import { getRssFeed } from './generator/rss/index.js'
 import type { ResolvedFeedOptionsMap } from './options.js'
 import { getFilename } from './options.js'
-import type { FeedConfig, FeedPluginFrontmatter } from './typings/index.js'
 import { logger } from './utils/index.js'
 
 export const getFeedFiles = (

plugins/plugin-feed/src/node/getTemplate.ts

@@ -1,9 +1,9 @@
 import { entries } from '@vuepress/helper/node'
 import { ensureEndingSlash } from 'vuepress/shared'
 import { fs, getDirname, path } from 'vuepress/utils'
+import type { FeedConfig } from '../typings/index.js'
 import type { ResolvedFeedOptionsMap } from './options.js'
 import { getFilename } from './options.js'
-import type { FeedConfig } from './typings/index.js'
 
 const __dirname = getDirname(import.meta.url)
 

plugins/plugin-feed/src/node/index.ts

@@ -1,2 +1,2 @@
-export * from './plugin.js'
-export * from './typings/index.js'
+export * from './feedPlugin.js'
+export * from '../typings/index.js'

plugins/plugin-feed/src/node/options.ts

@@ -14,15 +14,18 @@ import {
   removeLeadingSlash,
 } from 'vuepress/shared'
 import type {
-  BaseFeedOptions,
+  BaseFeedPluginOptions,
   FeedChannelOption,
-  FeedOptions,
-} from './typings/index.js'
+  FeedPluginOptions,
+} from '../typings/index.js'
 import { getUrl } from './utils/index.js'
 
 export interface ResolvedFeedOptions
-  extends Omit<BaseFeedOptions, 'sorter' | 'filter' | 'preservedElements'>,
-    Required<Pick<BaseFeedOptions, 'sorter' | 'filter'>> {
+  extends Omit<
+      BaseFeedPluginOptions,
+      'sorter' | 'filter' | 'preservedElements'
+    >,
+    Required<Pick<BaseFeedPluginOptions, 'sorter' | 'filter'>> {
   hostname: string
   isPreservedElement: (tagName: string) => boolean
 }
@@ -31,7 +34,7 @@ export type ResolvedFeedOptionsMap = Record<string, ResolvedFeedOptions>
 
 export const ensureHostName = (
   app: App,
-  options: Partial<FeedOptions>,
+  options: Partial<FeedPluginOptions>,
 ): boolean => {
   const hostname = app.env.isDev
     ? options.devHostname || `http://localhost:${app.options.port}`
@@ -49,7 +52,7 @@ export const ensureHostName = (
   return false
 }
 
-export const checkOutput = (options: Partial<FeedOptions>): boolean =>
+export const checkOutput = (options: Partial<FeedPluginOptions>): boolean =>
   // some locales request output
   (options.locales &&
     values(options.locales).some(
@@ -60,7 +63,7 @@ export const checkOutput = (options: Partial<FeedOptions>): boolean =>
 
 export const getFeedOptions = (
   { siteData }: App,
-  options: FeedOptions,
+  options: FeedPluginOptions,
 ): ResolvedFeedOptionsMap =>
   fromEntries(
     keys({
@@ -119,7 +122,7 @@ export const getFeedOptions = (
 
 export const getFeedChannelOption = (
   app: App,
-  options: FeedOptions,
+  options: FeedPluginOptions,
   localePath = '',
 ): FeedChannelOption => {
   const { base } = app.options
@@ -179,7 +182,7 @@ export const getFilename = (
   prefix = '/',
 ): Required<
   Pick<
-    FeedOptions,
+    FeedPluginOptions,
     | 'atomOutputFilename'
     | 'atomXslFilename'
     | 'jsonOutputFilename'