upcontent 0.1.4 → 0.1.5

package/customization/config-json.md

@@ -68,7 +68,7 @@ The optional fields below cover navigation, Starlight presentation, and content
     }
   },
   "navigation": {
-    "roots": ["README.md", "guides"],
+    "roots": ["index.md", "guides"],
     "labelOverrides": { "api": "API reference" },
     "blocklist": {
       "exact": ["notes.md"],

package/customization/navigation.md

@@ -7,7 +7,7 @@ sidebar:
 
 The sidebar is generated from the consumer file structure. Use configuration when the default filesystem order is not the right experience for readers.
 
-If the repository has a root `index.md`, it becomes the website homepage and a root `README.md` remains available at `/readme/`. Repositories without `index.md` keep the backwards-compatible behavior where `README.md` is the homepage.
+If the repository has a root `index.md`, it becomes the website homepage and the root `README.md` remains GitHub-only. Repositories without `index.md` keep the backwards-compatible behavior where `README.md` is the homepage.
 
 ## Select top-level roots
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "upcontent",
   "type": "module",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "packageManager": "pnpm@10.20.0",
   "repository": {
     "type": "git",

package/src/content.config.ts

@@ -86,6 +86,7 @@ function portalDocsLoader(): Loader {
       const homepage = hasRootIndex(docsBasePath) ? 'index' : 'readme'
       const patterns = [
         '**/[^_]*.{markdown,mdown,mkdn,mkd,mdwn,md,mdx}',
+        ...(homepage === 'index' ? ['![rR][eE][aA][dD][mM][eE].{markdown,mdown,mkdn,mkd,mdwn,md,mdx}'] : []),
         ...getBlocklist().map(blocked => `!${toCaseInsensitiveGlob(blocked)}${blocked.endsWith('/') ? '**' : ''}`),
       ]
       const wrappedContext: LoaderContext = {

package/src/lib/sidebar.test.ts

@@ -98,7 +98,7 @@ describe('buildSidebar', () => {
     mountFs(ROOT, { 'index.md': null, guides: { 'guide.md': null } })
 
     const sidebar = buildSidebar(ROOT)
-    expect(sidebar[0]).toEqual({ slug: 'index', label: 'Home' })
+    expect(sidebar[0]).toEqual({ slug: 'index', label: 'Getting Started' })
   })
 
   it('ignora dotfiles e dot-directories', () => {
@@ -110,13 +110,13 @@ describe('buildSidebar', () => {
   it('ignora arquivos bloqueados (floor hardcoded)', () => {
     mountFs(ROOT, { 'CLAUDE.md': null, 'README.md': null })
     const sidebar = buildSidebar(ROOT)
-    expect(sidebar).toEqual([{ slug: 'index', label: 'Home' }])
+    expect(sidebar).toEqual([{ slug: 'index', label: 'Getting Started' }])
   })
 
-  it('fixa o README em primeiro, relabelado como Home, na frente de tudo', () => {
+  it('fixa o README em primeiro, relabelado como Getting Started, na frente de tudo', () => {
     mountFs(ROOT, { 'README.md': null, domains: { historico: { 'a.md': null } } })
     const sidebar = buildSidebar(ROOT) as { label: string }[]
-    expect(sidebar[0]).toEqual({ slug: 'index', label: 'Home' })
+    expect(sidebar[0]).toEqual({ slug: 'index', label: 'Getting Started' })
     expect(sidebar[1].label).toBe('Historico')
   })
 
@@ -130,11 +130,11 @@ describe('buildSidebar', () => {
     expect(sidebar[0]).toEqual({ slug: 'index', label: 'Docs' })
   })
 
-  it('mantém README separado quando index.md é a homepage', () => {
+  it('não publica README quando index.md é a homepage', () => {
     mountFs(ROOT, { 'README.md': null, 'index.markdown': null, domains: { historico: { 'a.md': null } } })
     const sidebar = buildSidebar(ROOT) as { slug?: string; label?: string }[]
-    expect(sidebar[0]).toEqual({ slug: 'index', label: 'Home' })
-    expect(sidebar).toContainEqual({ slug: 'readme', label: 'Readme' })
+    expect(sidebar[0]).toEqual({ slug: 'index', label: 'Getting Started' })
+    expect(sidebar).not.toContainEqual({ slug: 'readme', label: 'Readme' })
   })
 
   it('aplica labelOverrides do .upcontent/config.json em cima do Title Case', () => {

package/src/lib/sidebar.ts

@@ -98,8 +98,11 @@ export function buildSidebar(docsRoot: string): SidebarEntry[] {
   const homepage = hasRootIndex(docsRoot) ? 'index' : 'readme'
   const configuredRoots = getPortalConfig().navigation?.roots
   const visibleTopLevel = configuredRoots
-    ? topLevel.filter(({ name, isDir }) => configuredRoots.includes(name) || (!isDir && ['index', 'readme'].includes(toSidebarSlug(name, homepage))))
-    : topLevel
+    ? topLevel.filter(({ name, isDir }) =>
+      !(homepage === 'index' && !isDir && toSidebarSlug(name, homepage) === 'readme')
+      && (configuredRoots.includes(name) || (!isDir && ['index', 'readme'].includes(toSidebarSlug(name, homepage))))
+    )
+    : topLevel.filter(({ name, isDir }) => !(homepage === 'index' && !isDir && toSidebarSlug(name, homepage) === 'readme'))
 
   const entries: SidebarEntry[] = []
   for (const { name, isDir } of visibleTopLevel) {
@@ -118,5 +121,5 @@ export function buildSidebar(docsRoot: string): SidebarEntry[] {
   const homepageIndex = entries.findIndex(e => !isSidebarGroup(e) && e.slug === 'index')
   const homepageEntry = homepageIndex >= 0 ? entries.splice(homepageIndex, 1)[0] : undefined
   const sorted = sortEntries(entries)
-  return homepageEntry ? [{ slug: 'index', label: resolveLabel(homepage, 'Home') }, ...sorted] : sorted
+  return homepageEntry ? [{ slug: 'index', label: resolveLabel(homepage, 'Getting Started') }, ...sorted] : sorted
 }