LOGOVALAXY
  • Config
  • API

  • client

      • addToParent

      • asAny

      • buildTree

      • computeZoomRectStyle

      • dayjs

      • decodePath

      • defineAppSetup

      • defineClientComponent

      • defineCollection

      • defineMermaidSetup

      • extractMarkdownImage

      • filterAndSortPosts

      • formatDate

      • getAddonDocsPath

      • getAddonModule

      • getHeaders

      • getLocaleMessageValue

      • hasLocaleMessage

      • initContext

      • initValaxyConfig

      • isCategoryList

      • isEmptyAddon

      • isLocaleKey

      • isReadmePage

      • isSamePagePath

      • isUnderscorePage

      • isUnpublishedPage

      • localizeAddon

      • mergeCollapsedCollections

      • mergePageExcludes

      • normalizeAddonLocale

      • normalizeExcludeGlobs

      • normalizePagePath

      • normalizeRepositoryUrl

      • notFoundSitemapPaths

      • omitProductionDraftRoutes

      • onClickHref

      • onContentUpdated

      • openGraphType

      • orderByMeta

      • pageExcludeGlobs

      • parseRangeString

      • pickShareImage

      • plainSeoDescription

      • publicAuthor

      • random

      • relativePagePath

      • removeItemFromCategory

      • resolveCanonicalPath

      • resolveCollectionItemHref

      • resolveHeaders

      • resolveShareImage

      • resolveSiteUrl

      • resolveTaxonomyLocaleKey

      • runCbs

      • scrollTo

      • serializeHeader

      • setIframeAspectRatios

      • sleep

      • sortByDate

      • sortByUpdated

      • stripEncryptedContent

      • stripLocalePrefix

      • svgToPng

      • throttleAndDebounce

      • tObject

      • useActiveAnchor

      • useAddonConfig

      • useBack

      • useBackToTop

      • useCategories

      • useCodePen

      • useCollapseCode

      • useCollection

      • useCollectionPosts

      • useCollections

      • useConfig

      • useCopyCode

      • useCopyMarkdown

      • useData

      • useDecrypt

      • useEncryptedContent

      • useEncryptedPhotos

      • useFrontmatter

      • useFullUrl

      • useFuseSearch

      • useInvisibleElement

      • useLayout

      • useLocale

      • useLocaleTitle

      • useLocalSearch

      • useMediumZoom

      • useMobile

      • useOutline

      • usePageList

      • usePageSeo

      • usePagination

      • usePartiallyEncryptedContents

      • usePostCollections

      • usePostList

      • usePostListWithCollections

      • usePostTitle

      • usePrevNext

      • useRuntimeConfig

      • useScreenSize

      • useSidebar

      • useSiteConfig

      • useTags

      • useValaxyApp

      • useValaxyConfig

      • useValaxyDark

      • useValaxyHead

      • useValaxyI18n

      • withBase

      • wrap

      • wrapTable

  • node

  • types

Function: isReadmePage() ​

Source: 1.2.2 · f05e2ff455c2

ts
function isReadmePage(relativePath): boolean;

Defined in: packages/valaxy/shared/page-policy.ts:52

Parameters ​

relativePath ​

string

Returns ​

boolean

Previous pageisLocaleKey
Next pageisSamePagePath
On this page

Released under the MIT License. (f05e2ff4)

Copyright © 2022-present YunYouJun & Valaxy Contributors